As I’m trying to navigate this whole “corporate technical docmentation” gig, I’d like to do a crossover between different types of writing disciplines.
Docs-as-code: the experience of writing objective content
An overwrite mechanism for machine- and human-friendly API documentation
There’s always issues with API documentation. It gets outdated quickly, it’s tedious and halfwhat standardized, and there’s not enough engineers who can write, nor enough writers who are techy enough. Automated documentation is useless, while human-crafted examples and descriptions take too long for the modern breakneck release cycle.
Beginning a Docs-as-Code journey
As a newly minted tech writer, I’ve had the pleasure to be given my first project in the software department: organize internal documentation. When you have guests come over, cleaning the rooms becomes a mad dash. And as I would expect, if external documentation is the polished, spick-and-span room where your guests are visiting, the internal documentation looks like the closet crammed of stuff.
See all tags.