Technical writing with Continuous Integration and docs-as-code
Now available on docslikecode.com, this explanation of how to integrate Swagger with Swashbuckle for a REST API written with C#. A Pirate’s Life for Me: Documenting APIs with Swagger In it, Adam Locke, their lone tech writer, describes his troubleshooting process, the toolset including DapperDocs, OpenAPI, Nuget, Packet, and some clever code. I appreciate reading […]
At the beginning of this year, I worked hard to summarize my thoughts on API documentation, continuous publishing, and technical accuracy for developer documentation. The result is an article on InfoQ.com, edited by Deepak Nadig, who also was forward-thinking in having me speak to a few teams at Intuit about API documentation coupled with code. Always […]
Leon Barnard from Balsamiq wrote up a great series of challenges and solutions for the docslikecode.com website. His lessons learned are super helpful for all of us: Challenge #1: Documenting multiple product versions Challenge #2: Adding play/pause to animated GIFs Challenge #3: Giving the list pages a makeover He summarizes the series best in his […]