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 Be Publishing: Continuous Integration & Collaboration in Code Repositories for REST API Docs
Here are the key takeaways from the article.
Key Takeaways
- API documentation provides a critical path for predicting customer success.
- Collaborating on documentation close to the code provides better reviews of both the code and the document files, more automation efficiencies, and enables quality tests for documentation specifically.
- Provide common documentation frameworks, standards, automation, and tools to give teams an efficiency boost.
If you have a story to tell about CI/CD for API docs, please send a Pull Request on GitHub to tell your story on http://docslikecode.com.