dodawanie i wyświetlanie dokumentacji w czasie rzeczywistym na stronach. Alternatywnymi nazwami tego modułu mogą być” dokumentacja kontekstowa „lub” dokumentacja czasu rzeczywistego”, ale inline ma ładny pierścień i pasuje do sposobu, w jaki dokumentacja jest umieszczana w kodzie.
ten moduł utworzy zawartość typu „Inline Documentation” i doda okrągły niebieski przycisk w prawym dolnym rogu każdej strony. Ten przycisk włącza panel zawierający listę wbudowanych węzłów dokumentacji.
dokumentacja jest kluczem do łatwej konserwacji lub przeniesienia projektu. Jednak nikt nie lubi pisać dokumentacji i nikt nie lubi czytać dokumentacji.
inline documentation stara się ułatwić pisanie dokumentacji poprzez umożliwienie użytkownikowi dodawania krótkich fragmentów dokumentacji bezpośrednio do strony internetowej, gdzie czytnik jej potrzebuje. Zmniejsza to zapotrzebowanie na rozbudowane strony Wiki i dokumenty Word.
przejdź do danej strony, kliknij przycisk „Dodaj dokumentację” i zacznij pisać niektóre dokumenty. Zaleca się, aby te dokumenty były krótkie i proste, można dodać dowolną liczbę do strony, a nawet dołączyć je do elementów DOM.