InfoQ Homepage Documentation Content on InfoQ
-
Building Organizational Resilience through Documentation and InnerSource Practices
David Grizzanti discusses how communication is more effective through writing, documentation helping drive clarity and alignment across teams, and where InnerSource practices can speed up development.
-
How to Write Code That Documents Itself
Dann Michelson discusses writing code that documents itself using proper naming, understandable architecture, consistent code style, and specialized tools.
-
Documenting RESTful APIs with Spring REST Docs
Jenn Strater introduces Spring REST Docs and its test-driven approach to RESTful API documentation.
-
Automated Testing of (RESTful) API Documentation
Rouven Wessling presents what's currently possible when it comes to testing documentation, how to start testing API documentation written using API Blueprints and how to incorporate it into a workflow
-
Building for Builders
Romain Huet presents ideas from how Stripe has created their developer documentation.
-
Automatic Discovery of Service Metadata for Systems at Scale
Martina Iglesias Fernández discusses Spotify’s approach to documentation through automatic discovery of existing endpoints, service configuration, and deployment information at runtime.
-
The Seven Righteous Fights
Heidi Waterhouse discusses seven issues to tackle during project development: Localization, Security, Extensibility, Documentation, Affordance, Acceptance, Accessibility.
-
Writing Comprehensive and Guaranteed Up-to-Date REST API Documentation
Andreas Evers introduces Spring REST Docs and its test-driven approach to RESTful API documentation.
-
We Need to Talk About Docs
Nik Wakelin discusses why developers dislike writing documentation, what can be done about it and how to improve the process of writing docs.
-
Documentation Avoidance for Programmers
Peter Hilton discusses how to avoid writing documentation, and when it must be done, how to write it, including tools and tips for writing minimal documentation.
-
Documenting RESTful APIs
Andy Wilkinson talks about what should be included in your RESTful API's documentation, as well as about some of the tools that are available for documenting services built using Spring.
-
Agile in a Highly Regulated Organization, Part 2
Tami Flowers details ways to successfully implement Agile while maintaining a formal yet lightweight SDLC, including documentation and deliverables, and governance and compliance.