]> rtime.felk.cvut.cz Git - edu/osp-wiki.git/blobdiff - student/vrchlpet/index.mdwn
Merge branch 'master' of rtime:edu/osp-wiki
[edu/osp-wiki.git] / student / vrchlpet / index.mdwn
index 3b2bc68d3d31a65403ced388693511b2fdb173f1..837e5c36437d657836eb9e7cc1f2cacaaf9d994f 100644 (file)
@@ -4,24 +4,35 @@
 
 **Domovská stránka projektu:** <http://filezilla-project.org/>
 
-Zadání
+Úvod
 ======
 
-Vyrvořit dokumentaci v podobě UML class diagramu pro clientskou část aplikace
+Zapojení se do vývoje tak rozsáhlého projektu jakým je Filezilla není vždy jednoduché. Celou situaci může 
+navíc ztížit absence dokumentace architektury aplikace. Pro nově příchozí vývojáře je z počátku největší 
+problém se zorientovat ve stávajícím kódu. Zapojení nových vývojářu do stávajícího projektu lze podpořit
+dobrou a čitelnou dokumentací, ve které se lze snadno orientovat. Důležitým aspektem každé dokumentace je 
+její aktuálnost a přístupnost. Cílem je tedy vytvořit systém, který bude poskytovat vždy aktuální dokumentaci 
+stávající verze aplikace, přičemž dokumentace bude přístupná online na webu projektu.
+
+
+Přesné zadání
+======
+
+Vyrvořit dokumentaci v podobě UML class diagramu pro clientskou část aplikace 
 
 [http://filezilla-project.org/](http://filezilla-project.org/)
 
 
+Dokumentace musí být generována automaticky pravidleně s nočními buildy.
+Nástroje použité pro tvorbu dokumentace musí být open-source a multiplatformní.
+
 Odkazy dokládající výsledky mé práce
 ======
 
 Zde přidám odkazy podobně jako v příkladu níže a popíšu na co
 jednotlivé odkazy odkazují.
 
-* [Odkazy na mou komunikaci s vývojáři v on-line archivech veřejných diskuzí...](http://groups.google.com/group/comp.os.minix/browse_thread/thread/e3df794a2bce97da/2194d253268b0a1b?#2194d253268b0a1b)
-* [Odkaz na můj repozitář s aktuálním stavem mé práce...](http://git.kernel.org/?p=linux/kernel/git/torvalds/linux-2.6.git;a=summary)
-* [Odkazy na mé commity v repozitáři projektu...](http://git.kernel.org/?p=linux/kernel/git/torvalds/linux-2.6.git;a=commit;h=ea90002b0fa7bdee86ec22eba1d951f30bf043a6)
-* [Další relevantní odkazy dokládající mou práci...](http://lwn.net/Articles/385586/)
+* [Odkazy na mou komunikaci s vývojáři](mail.pdf)
 
 Prezentace
 ==========