Pomoc - Szukaj - Użytkownicy - Kalendarz
Pełna wersja: Jak dokumentować program?
Forum PHP.pl > Inne > Hydepark
KirkoR
Na pewno każdy z Was spotkał się z tym problemem. Napisaliśmy fajną aplikacją ale w jaki sposób napisać dokumentację dla użytkowników. Nie chodzi mi tu o dokumentowanie kodu tylko o sposób działania aplikacji, czyli aby dodać artykuł to wejdź tu i zrób to...
Ja na razie używa OpenOffica i exportu do PDF. Macie inne pomysły? Jakich narzędzi używacie?
mike
Jeżeli chodzi o wyjściowy format dokumentacji to nie wyobrażam sobie żeby było to coś innego niż DocBook.
Jest do tego doskonały program: XMLmind XML Editor. Bardzo prosty i przyjazny.

Jeśli chodzi o dokumentację to pamiętaj że ma to być zrozumiałe nawet dla idiotów. Dla każdego a przede wszystkim dla ludzi nie związanych z "branżą".
Pokazujesz wszystkie screeny i opisujesz wszystkie unkcji.
Ot taki user manual.
Jabol
OpenOffice supportuje DocBooka. Darmowy, chociaż nie można powiedzeć, żeby był dużo lżejeszy od XML Mind. Oba są i tak bardziej wypasione niż trzeba.
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.