Standardy psaní dokumentace
Upozornění: Tohle vlákno je hodně staré a informace nemusí být platné pro současné Nette.
- Majkl578
- Moderator | 1364
Zdravím,
než začnu vrtat do dokumentace, zajímaly by mě nějaké detaily ohledně
formy obsahu:
- Psát primárně pro jakou verzi Nette a jakou PHP? Já jsem určitě pro verzi se jmennými prostory. Co ale verze Nette, vývojová (dev/alpha) nebo stabilní?
- Používat nějaký coding standard pro scripty, aby v nich nebyl binec? Celkem se mi zamlouvá a vesměs používám coding standard Nette.
Zároveň by bylo skvělé, kdyby se (tady) dokázalo domluvit pár lidiček na psaní/editaci/překládání, abysme s tím trochu pohli. Zatím jsme to já s Vrtákem, přidáte se?
- Jan Tvrdík
- Nette guru | 2595
- Dokumentace se píše primárně pro PHP 5.3 a se jmennými prostory (+ zmínka o rozdílech v PHP 5.2) a poslední stabilní verzi* (tj. aktuálně 0.9.4).
- Coding standard pro dokumentaci je stejný, jaký používá Nette.
- Články se tagují pomocí meta značky
{{tags}}– např.{{tags: php, code, demo}}(via Wiki syntax), výsledky tagů ale nejsou (AFAIK) nikde vidět a tudíž je to úplně na nic. - Pro experimenty, poznámky a organizaci máte k dispozici https://dev.nette.org/cs/
- Struktura dokumentace by měla vycházet z mnou navržené dokumentační struktury, můžete to brát i jako základ pro roadmap
- Primárním jazykem dokumentace je angličtina, pokud můžete, piště rovnou v ní, jinak samozřejmě můžete psát i česky
* Momentálně jsme v zajímavé situaci, kdy doporučená verze (1.0-alfa) není shodná se stabilní verzí (0.9.4). Nastává tak nová otázka, zda radši psát pro stabilní verzi nebo pro doporučenou.
- Patrik Votoček
- Člen | 2221
@phx: tahle otázka už se řešila snad 1000× rozdělení dokumentace do více větví v se bude řešit až bude dokumentace v takovém stavu kdy se to vyplatí. (tj. až bude dokumentace pro 1.0 „kompletní“ a příjde nová stable verze)