dotnetomaniak.pl - Artykuły z tagiem dokumentacje

Jako że omówiliśmy już jakie rodzaje dokumentacji należy tworzyć, możemy przejść do odpowiedzi na pytanie jak należy rozwinąć styl, dzięki której taką dokumentację będzie dało się czytać. Naucz się pisać Niestety, nie ma tutaj dróg na skróty. Najlepszym sposobem na nauczenie się jak pisać dobrą dokumentację jest najpierw nauczyć się pisać (cokolwiek). Istnieją pewne istotne różnice między dokumentacją techniczną i Twoją przeciętną prozą, ale solidne podstawy w komunikacji pisemnej są wymaganiem nie do za...

Tagi: dokumentacje
Źródło: www.devblogi.pl
Dziel się z innymi:
devBlogi: Pisanie dobrej dokumentacji: styl

Inne 4010 dni, 2 godziny, 17 minut temu gordon_shumway 56 źrodło rozwiń

Dokumentacja techniczna może przybrać różnoraką formę - od wysokopoziomowego przeglądu, przez instrukcje krok po kroku, aż po automatycznie generowaną dokumentację API. Niestety, żaden format nie jest satysfakcjonujący dla wszystkich użytkowników; różnice w sposobie uczenia się ludzi są ogromne, a więc dobrze udokumentowane projekty muszą dostarczać dokumentacji pod wieloma postaciami.

Źródło: www.devblogi.pl
Dziel się z innymi:
devBlogi: Pisanie dobrej dokumentacji: co napisać

Inne 4030 dni, 15 godzin, 52 minuty temu macko 69 źrodło rozwiń

Dziś zajmę się dość powszechnym wydaje się problemem, a mianowicie tworzeniem dokumentacji dla oprogramowania. Zwykle owa dokumentacja powstaje dopiero pod koniec tworzenia oprogramowania, nie ma na nią za wiele czasu i oczywiście "chcemy to zrobić tak, by się nie narobić" :). W takim momencie chyba każdemu przychodzi na myśl wykorzystanie jakiegoś edytora (np. Microsoft Word lub OpenOffice Writer). Dlaczego? Bo łatwo i wiele osób wie jak Word'a obsługiwać, jak sformatować tekst, je...

Maciej Zbrzezny: Programowanie i Technologie: Tworzenie dokumentacji

Narzędzia 4464 dni, 6 godzin, 41 minut temu paduda 140 źrodło rozwiń

Artykuł omawia czynności, które pozwalają na przyspieszenie generowania dokumentacji przy użyciu Sandcastle.

Dziel się z innymi:
3 sposoby na przyśpieszanie wolnego Sandcastle | Polishwords Blog

Inne 4481 dni, 7 godzin temu paduda 43 źrodło rozwiń

Konkurs z Code Europe - ranking

1
(30,04)
3
(15)
4
(15)
5
(5,01)

Najaktywniejsi w tym miesiącu

1
(45,05)
3
(15,07)
4
(15,03)
6
(15)
7
(15)
8
(15)
9
(5,01)
10
(5)