Witaj Gościu! ( Zaloguj | Rejestruj )

Forum PHP.pl

 
Reply to this topicStart new topic
> Dokumentacja techniczna
artek
post 2.12.2015, 12:34:11
Post #1





Grupa: Zarejestrowani
Postów: 49
Pomógł: 0
Dołączył: 6.10.2015

Ostrzeżenie: (0%)
-----


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?
Go to the top of the page
+Quote Post
Pyton_000
post 2.12.2015, 12:47:52
Post #2





Grupa: Zarejestrowani
Postów: 8 068
Pomógł: 1414
Dołączył: 26.10.2005

Ostrzeżenie: (0%)
-----


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

Czasami wystarczy zwyczajny opis, czasami jakiś UML a inni oczekują dokumentacji na poziomie Pana Tadeusza.
Go to the top of the page
+Quote Post
artek
post 7.12.2015, 11:54:54
Post #3





Grupa: Zarejestrowani
Postów: 49
Pomógł: 0
Dołączył: 6.10.2015

Ostrzeżenie: (0%)
-----


Cytat(Pyton_000 @ 2.12.2015, 12:47:52 ) *
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
Go to the top of the page
+Quote Post
undefinedman
post 8.12.2015, 21:55:29
Post #4





Grupa: Zarejestrowani
Postów: 7
Pomógł: 0
Dołączył: 30.01.2010

Ostrzeżenie: (0%)
-----


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.
Go to the top of the page
+Quote Post
Janusz15
post 11.08.2017, 11:09:52
Post #5





Grupa: Zarejestrowani
Postów: 1
Pomógł: 0
Dołączył: 11.08.2017

Ostrzeżenie: (0%)
-----


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,
Go to the top of the page
+Quote Post

Reply to this topicStart new topic
1 Użytkowników czyta ten temat (1 Gości i 0 Anonimowych użytkowników)
0 Zarejestrowanych:

 



RSS Wersja Lo-Fi Aktualny czas: 28.03.2024 - 09:27