Add and view documentation in realtime on pages. Vaihtoehtoiset nimet tälle moduulille voisivat olla” kontekstuaalinen dokumentaatio ”tai” reaaliaikainen dokumentaatio”, mutta inline kuulostaa mukavalta ja vastaa tapaa, jolla dokumentaatio sijoitetaan koodiin.
tämä moduuli luo sisältötyypin ”Inline Documentation” ja lisää pyöreän sinisen painikkeen jokaisen sivun oikeaan alakulmaan. Tämä painike vaihtaa paneelin, joka sisältää luettelon inline-dokumentaatiosolmuista.
dokumentointi on avain helppoon kunnossapitoon tai projektin siirtoon. Kukaan ei kuitenkaan halua kirjoittaa dokumentteja, eikä kukaan halua lukea niitä.
Inline-dokumentaatio pyrkii helpottamaan dokumentaation kirjoitustaakkaa yksinkertaisesti antamalla käyttäjän lisätä lyhyitä dokumentaation palasia suoraan verkkosivulle, jossa lukija sitä tarvitsee. Tämä vähentää laajojen Wiki-sivujen ja Word-dokumenttien tarvetta.
siirry kyseiselle sivulle, napsauta ”lisää dokumentaatio” – painiketta ja aloita dokumenttien kirjoittaminen. On suositeltavaa pitää nämä dokumentit lyhyinä ja yksinkertaisina, voit lisätä sivulle niin monta kuin haluat ja voit jopa liittää ne DOM-elementteihin.