Zpět do vitrínkyvitrinka.Dokument · Dokumenty

Dokument

Stránky, které na něco ukazují.

Živé dokumenty propojené se systémem, který popisují — navázané na vaše soubory, prolinkované s diagramy a platné i za měsíc.

01

Psané společně

Stránka se upravuje tam, kde je, několika lidmi najednou, a agent čte i píše tutéž stránku jako markdown — žádný export, žádný import.

  • Živá společná úprava — změny všech se slučují, jak kdo píše, a kdo stránku otevře později, dostane ji celou, ne zastaralou kopii.
  • Komentáře na okraji — čtenáři komentují pasáž nebo si v ní vyznačí oblast a vlákno sedí v liště hned vedle toho, čeho se týká; vlákna, která odjela z obrazovky, se shromáždí do pilulky, která vás k nim vrátí jedno po druhém. Komentovat může i host s odkazem pro anotace — pod jménem, které si zvolí, bez účtu — a jeho komentáře počkají na tým.
  • Jeden text, víc čtenářů — sekce označené podle publika zmizí, když přepnete čtenáře, takže týmová verze i release notes pro zákazníka vzniknou z jednoho zdroje — a dokument odejde jako PDF, HTML, koncept e-mailu nebo soubor pro Word.
Dokumenty a stránky v dokumentaci

02

Navázané na vaše soubory

Stránku lze navázat na soubor v repozitáři, i se zdrojem a revizí, takže se dá obnovit, když se soubor změní — nebo do něj zapsat zpátky.

  • Navázaná na soubor — stránka ví, ze kterého souboru pochází a na jaké je revizi.
  • Obnova po úpravách — změňte soubor, obnovte stránku a nástěnka to dožene.
  • Zápis zpátky — tok jde i opačně: upravte na nástěnce, zapište do souboru, commitněte.

03

Rovnou na uzel

Odkažte odstavec přímo na prvek diagramu, který vysvětluje, aby se text a obrázek přestaly rozcházet.

  • Odstavec na uzel — odkaz přistane na konkrétním prvku, ne na diagramu obecně.
  • Oběma směry — diagram odkazuje zpět na stránku, takže cestou dovnitř je obojí.

04

Jeden zdroj, dva domovy

Stejný text slouží nástěnce i dokumentaci, takže nikdo neudržuje druhou kopii, která postupně přestane sedět s první.

  • Nástěnka i repozitář — jeden dokument, dostupný z obou stran.
  • Markdown — stránky se skládají v markdownu, ne v uzavřeném formátu.