Aggiungere e visualizzare la documentazione in tempo reale sulle pagine. I nomi alternativi per questo modulo potrebbero essere “Documentazione contestuale” o “Documentazione in tempo reale”, ma inline ha un bell’anello e corrisponde al modo in cui la documentazione viene inserita nel codice.
Questo modulo creerà un tipo di contenuto “Documentazione in linea” e aggiungerà un pulsante blu rotondo nell’angolo in basso a destra di ogni pagina. Questo pulsante commuta un pannello contenente un elenco dei nodi di documentazione in linea.
La documentazione è la chiave per una facile manutenzione o trasferimento del progetto. Tuttavia, a nessuno piace scrivere documentazione e a nessuno piace leggere la documentazione.
La documentazione in linea cerca di facilitare il carico di scrittura della documentazione semplicemente consentendo all’utente di aggiungere brevi bit di documentazione direttamente alla pagina Web in cui il lettore ne ha bisogno. Questo riduce la necessità di ampie pagine Wiki e documenti Word.
Vai alla pagina in questione, fai clic sul pulsante “Aggiungi documentazione” e inizia a scrivere alcuni documenti. Si consiglia di mantenere questi documenti brevi e semplici, puoi aggiungerne quanti ne vuoi a una pagina e puoi persino collegarli agli elementi DOM.