Documenting Software Architecture When we need to explain to someone else (new developer, product owner, investor, …) how the application works, we need documentation. But what documentation option…
The Ultimate Guide To Software Architecture Documentation
This guide shows you how to write, structure, visualize and manage software architecture documentation using appropriate documentation tools.
Documenting software architecture with arc42
arc42 is a template for architecture communication and documentation. It is a proven, practical and highly pragmatic approach and takes the pain out of documentation.
Things That Don't Seem Like Documentation
When developers think of documentation, we often tend to think of walls of texts or verbose reference guides. However, the purpose of documentation is to be the UI layer for an API or code library: when you’re learning something new, documentation is the frontend that you spend most of your time interacting with.
Documentation is more than you think
Everything that is involved in making great documentation everywhere and all at once.
Building great open source documentation
Docs as Code: The Best Guide for Technical Writers
Recently, my work has involved writing a lot of documentation and. Doing this has introduced me to...
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
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.
Foundation Models | Apple Developer Documentation
Perform tasks with models that specialize in language understanding, structured output, and tool calling.
Foundation Models | Apple Developer Documentation
Perform tasks with models that specialize in language understanding, structured output, and tool calling.
Architecture diagrams should be code - BAM Weblog
For the past few years I’ve been the most senior developer on my teams in Atlassian, in both position (Principal Engineer) and time (almost 9 years) - this means I usually take on the responsibility of managing our software architecture.
Colibri Social Documentation
Learn about Colibri's architecture, specification, and how to contribute.
Colibri Social Documentation
Learn about Colibri's architecture, specification, and how to contribute.
Docs as Code
author, Eric Holscher& the Write the Docs community,. Documentation as Code ( Docs as Code) refers to a philosophy that you should be writing documentation with the same tools as code: Issue Tracke...
