The Art and Science of Documentation
The Art and Science of Documentation
Start here
Architecture Decisions in the Age of AI
Using ADRs to constrain AI-assisted development and preserve intent
Documentation in the age of AI
Why documentation matters now more than ever
All posts tagged "documentation"
template-bash, a starter for Bash engineering
Introducing template-bash, the private starter repository behind the free Bash Engineering Starter Kit.
One Documentation Model Across Bash, AWK, Python, and PHP
Bash, AWK, Python, and PHP need different source-documentation techniques, although they can still participate in one consistent Doxygen-generated documentation model.
python-doxygen, when Python docstrings meet Doxygen
Introducing python-doxygen, a documentation filter that translates Python-native docstrings into structured Doxygen documentation without requiring a second documentation dialect in maintained Python.
awk-doxygen, Doxygen documentation for AWK
Introducing awk-doxygen, a documentation-led Doxygen filter for maintained AWK programs.
bash-doxygen, Doxygen documentation for Bash
Introducing bash-doxygen, a conservative Doxygen filter for documented Bash declarations.
ADRs Are The Antidote to "Because That's How We've Always Done It"
Architecture Decision Records preserve the context and reasoning behind technical decisions so future teams can understand, evaluate, and reconsider them.
Bootstrap, an engineering exercise (part 3)
Taking an idea for a shell script and applying full engineering processes to see what an AI-generated Bash script could accomplish.
Bootstrap, an engineering exercise (part 2)
Taking an idea for a shell script and applying full engineering processes to see what an AI-generated Bash script could accomplish.
Bootstrap, an engineering exercise (part 1)
Taking an idea for a shell script and applying full engineering processes to see what an AI-generated Bash script could accomplish.
Bootstrap, an engineering exercise (intro)
Taking an idea for a shell script and applying full engineering processes to see what an AI-generated Bash script could accomplish.
Bash Shell Script Usage Generation based on Doxygen Comments
Metrics, Intent, and the Drift Problem in AI-Assisted Development
How metrics lead us to a skewed and incomplete understanding of a system and that misunderstanding is amplified by AI and LLM-assisted coding; capturing intent through documentation can help capture what metrics miss while reducing drift and preserving intention
Architecture Decisions in the Age of AI
Using ADRs to constrain AI-assisted development and preserve intent
Documentation in the age of AI
Why documentation matters now more than ever