Witaj Gościu! ( Zaloguj | Rejestruj )

Forum PHP.pl

 
Reply to this topicStart new topic
> Jak dokumentować program?
KirkoR
post
Post #1





Grupa: Zarejestrowani
Postów: 118
Pomógł: 0
Dołączył: 14.02.2004
Skąd: Warszawa

Ostrzeżenie: (10%)
X----


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?
Go to the top of the page
+Quote Post
mike
post
Post #2





Grupa: Przyjaciele php.pl
Postów: 7 494
Pomógł: 302
Dołączył: 31.03.2004

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


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.
Go to the top of the page
+Quote Post
Jabol
post
Post #3





Grupa: Przyjaciele php.pl
Postów: 1 467
Pomógł: 13
Dołączył: 22.02.2003

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


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.
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 Aktualny czas: 21.08.2025 - 20:21