If quality depends on consumers' perception, how can API documentation influence it?
Documentation is more than you think
Everything that is involved in making great documentation everywhere and all at once.
Why good non-techie user documentation is vital for a wider embrace of the ATmosphere - Debbie's Blatherings - by Debbie Ridpath Ohi
Plus tips on writing good user documentation
Making Documentation Simpler and Practical: Our Docs-as-Code Journey — Squarespace Engineering Blog
In the fast-paced world of software development, documentation often gets a bad rap. It's perceived as a chore, a necessary evil, and sometimes, unfortunately, an afterthought. But what if writing documentation could be as dynamic and collaborative as writing the code itself? What if it could be si
The Best API Documentation Tool
OpenAPI-generated documentation tool with 24k+ stars on Github - make APIs your company's superpower.
How to Document Event-Driven API Message Payloads
Documenting event-driven payloads is necessary to promote healthy consumption.
Establishing Trusted Representation | CAA
Labelling of quality and price is an important key for selecting goods or services. False or misleading representations may sway consumers into buying goods or services that are actually poor quality or overvalued. The Act against Unjustifiable Premiums and Misleading Representations prohibits such misleading representations. The Consumer Affairs Agency is addressing to ensure proper environment for shopping according to the Act.
Full featured documentation deployment platform
Read the Docs is a documentation building and hosting platform aimed at helping developers creating documentation from code with versioned documentation, integrated search, pull request previews and more.
The Good Docs Project · GitLab
The Good Docs Project educates and empowers people to create high-quality documentation by providing them with templates, resources, best practices, and tools to enhance their documentation in open...
How to create software quality.
I’ve been reading Steven Sinofsky’s Hardcore Software, and particularly enjoyed this quote from a memo discussed in the Zero Defects chapter: You can improve the quality of your code, and if you do, the rewards for yourself and for Microsoft will be immense. The hardest part is to decide that you want to write perfect code. If I wrote that in an internal memo, I imagine the engineering team would mutiny, but software quality is certainly an interesting topic where I continue to refine my thinking. There are so many software quality playbooks out there, and I increasingly believe that all these playbooks work in their intended context, but are often misapplied.
Testing data quality effectively
Learn how focusing on user value and trust gives you a clearer, more effective way to test data quality
API Improvement Proposals
AIPs are design documents that summarize Google's API design decisions. They also provide a framework and system for others to document their own API design rules and practices.
Why Executive Interest In APIs Is Booming
A decade ago, API awareness was limited, with evangelists educating a mostly unaware C-suite. Today, APIs are integral to business, widely embraced by executives and developers alike, reflecting a significant shift in digital transformation strategies.
“I think there’s a lot of value in these.” – Unsung
A blog about software craft and quality
