Inline dokumentace

Přidat a zobrazit dokumentaci v reálném čase na stránkách. Alternativní názvy tohoto modulu mohou být „kontextová dokumentace“ nebo „dokumentace v reálném čase“, ale inline má pěkný prsten a odpovídá způsobu, jakým je dokumentace umístěna v kódu.

tento modul vytvoří typ obsahu „Inline dokumentace“ a přidá kulaté modré tlačítko do pravého dolního rohu každé stránky. Toto tlačítko přepíná panel obsahující seznam uzlů inline dokumentace.

dokumentace je klíčem pro snadnou údržbu nebo přenos projektu. Nikdo však nemá rád psaní dokumentace a nikdo nemá rád čtení dokumentace.

Inline dokumentace se snaží zmírnit zatížení psaní dokumentace jednoduše tím, že umožňuje uživateli přidat krátké kousky dokumentace přímo na webovou stránku, kde ji čtenář potřebuje. To snižuje potřebu rozsáhlých Wiki stránek a dokumentů aplikace Word.

přejděte na příslušnou stránku, klikněte na tlačítko „Přidat dokumentaci“ a začněte psát některé dokumenty. Doporučuje se, aby tyto dokumenty byly krátké a jednoduché, na stránku můžete přidat tolik, kolik chcete, a dokonce je můžete připojit k prvkům DOM.

Napsat komentář

Vaše e-mailová adresa nebude zveřejněna.