writedocs

Voor softwareteams die een openbare plek nodig hebben voor producthandleidingen en API-referenties, zet WriteDocs een GitHub-documentatierepository om in een gehost documentatieportaal. Schrijf pagina’s in Markdown of MDX, deel ze in onder navigatie- en productsecties en bekijk wijzigingen lokaal met de WriteDocs CLI. Zodra je updates naar GitHub pusht, wordt het portaal automatisch gepubliceerd. Teams kunnen de vormgeving en structuur van een portaal aanpassen, paginasjablonen en herbruikbare componenten gebruiken en API-referentiepagina’s genereren op basis van OpenAPI-bestanden. API-pagina’s bevatten een interactieve playground waarin ontwikkelaars requests kunnen versturen en reacties kunnen bekijken. WriteDocs kan geschikt zijn voor teams die vertrouwd zijn met een documentatie-als-codeworkflow en hun producthandleidingen en ontwikkelaarsdocumentatie naast hun code willen onderhouden.

Disclaimer: WebCatalog is niet gelieerd aan, verbonden met, geautoriseerd door, onderschreven door of op enige wijze officieel verbonden met writedocs. Alle productnamen, logo's en merken zijn eigendom van hun respectieve eigenaren.