Pomoc - Szukaj - Użytkownicy - Kalendarz
Pełna wersja: [inne] Dokumentacja użytkownika, techniczna
Forum PHP.pl > Forum > Przedszkole
potreb
Witam wszystkich.

Chciałbym się dowiedzieć od tych nieco już ze stażem czy tworzyli jakąś dokumentację techniczną, użytkownika oprogramowania (cms) dla wykonawcy.
Zazwyczaj bywa tak, że Zamawiający chce dokumentację oczywiście z przeniesieniem praw autorskich i majątkowych do utworu wraz z dokumentacją techniczną, użytkownika. Tak naprawdę firmy rzadko dokładnie opisują swoje oprogramowanie, w szczególności że im więcej wiemy w zakresie oprogramowania możemy zacząć sami rozwijać oprogramowanie pomijając następne zlecenie do wykonawcy.

Oczywiście komentowanie kodu to podstawa, ja sam komentują bo później zapominam do czego dana funkcja służy. Jednak czy macie jakieś dobre metody tworzenia dokumentacji użytkownika czy też technicznej w wersji pdf, html (takiej też do druku)? Czy naprawdę w takiej technicznej dokumentacji warto opisywać każdą funkcje, żeby Wykonawca mógł bez problemu sam zmieniać oprogramowanie? Jak wy do tego podchodzicie?
lobopol
Kwestia umowy, ja zawszę dla siebie robię dokumentacje phpdocem. Dla klienta instrukcja instalacji + instrukcja konfiguracji
potreb
Instrukcja instalacji razem z systemem? Bo ja przynajmniej musiałem taką napisać. Dokładnie pod właściwy system :/ Raczej mi tutaj chodzi o tworzenie step by step instrukcji użytkownika. Prostej, zrozumiałej krok po kroku. Nie wszyscy są programistami.
To jest wersja lo-fi głównej zawartości. Aby zobaczyć pełną wersję z większą zawartością, obrazkami i formatowaniem proszę kliknij tutaj.
Invision Power Board © 2001-2025 Invision Power Services, Inc.