Inline dokumentation

Lägg till och visa dokumentation i realtid på sidor. Alternativa namn för den här modulen kan vara” kontextuell dokumentation ”eller” Realtidsdokumentation ” men inline har en fin ring till den och matchar hur dokumentationen placeras i kod.

den här modulen skapar en innehållstyp” Inline Documentation ” och lägger till en rund blå knapp längst ner till höger på varje sida. Den här knappen växlar en panel som innehåller en lista över inline-dokumentationsnoder.

dokumentation är nyckeln för enkelt underhåll eller projektöverföring. Men ingen gillar att skriva dokumentation och ingen gillar att läsa dokumentation.

Inline documentation försöker underlätta belastningen av att skriva dokumentation helt enkelt genom att låta användaren lägga till korta bitar av dokumentation direkt till webbsidan där läsaren behöver det. Detta minskar behovet av omfattande Wiki-sidor och Word-dokument.

navigera till sidan i fråga, klicka på knappen ’Lägg till dokumentation’ och börja skriva några dokument. Det rekommenderas att hålla dessa dokument korta och enkla, du kan lägga till så många du vill på en sida och du kan till och med bifoga dem till DOM-element.

Lämna ett svar

Din e-postadress kommer inte publiceras.