2024
Documentation as code in automotive system/software engineering
The best overview I know of docs-as-code in a professional automotive project: Dr. Momcilo Krunic's paper on an ASPICE-compliant setup with 150 engineers – republished with his permission.
Read more →
Manager POV: What's the benefit of docs-as-code?
A fictitious conversation with a project manager of a 500-person automotive software project: why documentation quality suffers in expert tools and how docs-as-code helps.
Read more →2021
Process documents with Sphinx-Needs
Document processes and workflows the docs-as-code way: a process model with Sphinx-Needs, checked by the build, linkable from project requirements – with metrics for free.
Read more →
Open-Needs-DB gets funded
The Prototype Fund of the German Federal Ministry of Education and Research finances Open-Needs-DB: a REST database to share requirements between projects.
Read more →
Sphinx extension development: tips & tricks
What I learned from writing Sphinx extensions: learn from other extensions, use a namespace, support parallel builds, manipulate the node tree – and let your docs be your test.
Read more →
Docs-as-code enhanced
Docs-as-code is more than storing docs in Git: with Sphinx-Needs, the content itself becomes code – reusable, linkable objects right inside your text.
Read more →
Page meta data in Sphinx
Who is responsible for a page, and when did it last change? Sphinx-Needs stores this as a discreet metadata object on every page – reusable in tables and filters.
Read more →
String2Link transformation with Sphinx-Needs
Write an issue ID or a user name, get a link: the string-links feature of Sphinx-Needs turns option values into links to external tools.
Read more →PyCharm file watchers for Sphinx projects
See your Sphinx documentation as fast as possible: a PyCharm file watcher rebuilds the HTML on every change – with all extensions and your normal build command.
Read more →