RSS kanál#1 před 2 lety
- crempa
- Člen
- Registrovaný: 21. 8. 2008
- Příspěvky: 207
V čem píšete projektové dokumentace ?
Ahoj, poradíte nějaký nástroj pro tvorbu projektových dokumentací? Doteď jsem si vystačil s openoffice + paint.net ale je to takové nešikovné a těžko se s tím dokumentace udržuje aktuální a stejnorodá.
Představuju si nástroj který bude řešit vše od snímání obrazovek, přes jednoduché nástroje pro popis GUI na snímcích, následné zasazení do textu až třeba po nějaký systém verzování atd. Výstup nejlépe do PDF asi, ale kdyby to umělo na základě podkladů vytvořit i jakousi wikinu či obecně webovou dokumentaci s možností diskutovat nad jednotlivými kapitolami apod. tím lépe. O možnostech napojení dokumentace na samotný zdroják projektu a např. využívání dokumentačních komentářů si už iluze moc nedělám :-)
Jinak hledám program pro Windows a při tom co jsem si navymýšlel nepočítám s tím že bude zdarma… :-)
Díky
#2 před 2 lety
- filda
- Člen
- Registrovaný: 9. 11. 2005
- Příspěvky: 14
Re: V čem píšete projektové dokumentace ?
obyčejná wiki s napojením na svn by nestačila?
#3 před 2 lety
- crempa
- Člen
- Registrovaný: 21. 8. 2008
- Příspěvky: 207
Re: V čem píšete projektové dokumentace ?
wiki je az vysledek, ja potrebuju nastroj, jak ve wikine zdokumentuju screenshot z GUI ?
#4 před 2 lety
- filda
- Člen
- Registrovaný: 9. 11. 2005
- Příspěvky: 14
Re: V čem píšete projektové dokumentace ?
vložim obrázek a popíšu co na něm je, ale možná mám zcestnou představu o tom co je „projektová dokumentace“
#5 před 2 lety
- crempa
- Člen
- Registrovaný: 21. 8. 2008
- Příspěvky: 207
Re: V čem píšete projektové dokumentace ?
Nazev projektova dokumentace je mozna trochu zavadejici, mam na mysli dokumentaci pro koncove uzivatele… tj. treba onim popisem GUI jsem myslel screenshot s zlutejma bublinama, ktere to gui popisuji, ruzne ohranicene oblasti s napisy typu „sem napiste rozmery A“ atd. ⇒ to cele editovatelne i v budoucnu s prichodem novych verzi aplikace a vhodnym zpusobem kombinovane s textovou casti dokumentace…
#6 před 2 lety
- filda
- Člen
- Registrovaný: 9. 11. 2005
- Příspěvky: 14
Re: V čem píšete projektové dokumentace ?
Já jsem v tomhle trochu zvrácenej, protože si myslím, že i dokumentace
pro uživatele lze psát ve wiki. Spousta wiki systémů má například export
do PDF. Takže mě by stačilo najít plugin na editaci obrázků.
Navíc se mi líbí ta možnost, že na wiki dokumentaci lze odkázat přímo
z aplikace.
#7 před 2 lety
- paranoiq
- Člen
- Registrovaný: 14. 11. 2006
- Příspěvky: 350
Re: V čem píšete projektové dokumentace ?
a ideální je, kldyž si uživatelé v té wiki napíšou dokumentaci sami :]
- twitter: http://twitter.com/paranoiq/
#8 před 2 lety
- Koubas
- Člen
- Registrovaný: 20. 2. 2009
- Příspěvky: 8
Re: V čem píšete projektové dokumentace ?
To co popisuješ není projektová dokumentace a o žádném podobném nástoriji nevím, ale pro opravdovou projektovou dokumentaci doporučuju Trac. Je to mix wiki a ticket systému (např. pro bug tracking a úkolování) a obě tyto funkce umí výborně kombinovat se svým browserem repozitářu SVN a podobných systémů, kde je pak možno psát wiki stránky k jednotlivým zdrojovým souborům, s (jedním z mnoha) diskusních pluginů mít např. pod každým souborem diskusi a pod., pluginů jsou mraky.
paranoiq napsal(a):
a ideální je, kldyž si uživatelé v té wiki napíšou dokumentaci sami :]
jj, už jsem viděl pár OS aplikací (třeba Magento), kde je např. v rohu odkaz „Help“, který vede na automaticky vygenerovanou URL do wiki (url se generuje např. z aktuálního modulu/controlleru, ve kterém se v aplikaci nacházíte, třeba pro panel settings v administraci wiki.example.com/refference-guide/admin/settings). Ta stránka třeba vůbec neexistuje, ale jelikož je to wiki, tak stačí, aby někdo hodný kliknul na Create page a může dokumentovat pro ostatní.
#9 před 2 lety
- crempa
- Člen
- Registrovaný: 21. 8. 2008
- Příspěvky: 207
Re: V čem píšete projektové dokumentace ?
Potrebuju zdokumentovat projekt pro zakaznika a proto tomu rikam projektova dokumentace, vyrazy jako navod ci manual jsou asi presnejsi. Uzivatele budou BFU a tudiz to musi byt plne ilustraci a peknouckych ovalnych ukazatelu se stinem…
TRAC jako takovy povazuju za vrcholnou ukazku nepouzitelnosti a osklivosti, ale to je muj osobni nazor. Kazdopadne nemuzu chtit po zakaznikoj aby zastavil cinnost a nechal psat zamestnance pulku pracovni doby po dobu jednoho tydne wikinu… ;) Bavim se tu celou dobu o komercnim projektu a ne OSS aplikaci, tam by se urcite nejaka wiki nasadit dala…
Zkusim se podivat co v tom smeru nabizi MS Project.
Editoval crempa (7. 9. 2009 9:10)
#10 před 2 lety
- paranoiq
- Člen
- Registrovaný: 14. 11. 2006
- Příspěvky: 350
Re: V čem píšete projektové dokumentace ?
@koubas: přesně tak jsem to myslel
@crempa: i když moje poznámka byla trošku sarkastická, myslel jsem to vážně a i já mluvím o komerčním projektu:
- pro uživatele je nejlepší, když je manuál vždy po ruce – a tedy nejlépe přímo v aplikaci
- zkušený uživatel má možnost doplnit dokumentaci tam, kde vývojář byl přespříliš stručný, aniž by musel podstoupit kolečko začínající hlášením chyby (a končící tím, že každý uživatel má jinou verzi dokumentace)
- wiki přístup usnadňuje i psaní dokumentace. mohou ji upravovat vývojáři a testeři během práce. přímo když zjistí, že je to třeba
Kazdopadne nemuzu chtit po zakaznikoj aby zastavil cinnost a nechal psat zamestnance pulku pracovni doby po dobu jednoho tydne wikinu
to samozřejmě ne. nebo ano? ;-)
- twitter: http://twitter.com/paranoiq/