Dokumentacja techniczna Opcje

[artek]

Witam, w naszym zawodzie najlepiej pisze nam się kod, ale mnie dotknęło pisanie dokumentacji technicznych, w zasadzie dwóch, oprogramowania, które stworzyłem oraz dotyczące migracji serwera. Czy moglibyście mi pomóc? podrzucić jakieś przykładowe, dać wskazówki?

[Pyton_000]

To zależy kto i czego od Ciebie wymagają.

Czasami wystarczy zwyczajny opis, czasami jakiś UML a inni oczekują dokumentacji na poziomie Pana Tadeusza.

[artek]

To zależy kto i czego od Ciebie wymagają.

Czasami wystarczy zwyczajny opis, czasami jakiś UML a inni oczekują dokumentacji na poziomie Pana Tadeusza.

Odnośnie przeniesienia, oczekują ode mnie opisania wszystkiego. Przenoszony jest duży serwis, podpiętych dziesiątki mechanizmów i ma to być "książka". Jak przenosić, co zmieniać, krok po kroku co robić, gdy coś pójdzie nie tak... Takiego przykładu szukam.

Odświeżę, ma ktoś może jakąś przykładową dokumentację, np. przeniesienia serwera lub pokrewną? Im bardziej szczegółowa, tym lepiej

[undefinedman]

Raczej nie istnieje jakiś przykład. Napisałem już kilka sporych dokumentacji technicznych po angielsku, no i za każdym razem idzie to super custom. Na początku próbowałem się wzorować na typowych dokumentacjach technicznych, ale jednak w miarę upływu czasu, doświadczenie bierze górę.

Dokumentacja techniczna, o której wspomniałeś - dotycząca migracji - jest już czymś bardzo niestandardowym.

[Janusz15]

Dobry!

Odświeżam temat, może macie jakąś nową poradę.
W pracy dostałem zadanie na zasadzie, masz kod, komentarzy zbyt nie ma, wcześniej dokumentacji nie było, ale powodzenia!

Generowanie dokumentacji przynosi marny efekt niestety.

Gdybyście mogli poratować jakąś poradą/sugestią/szablonem/czymkolwiek będę wdzięczny.

Pozdrawiam,