The Writulos Blog

Guides on writing, automating and keeping code documentation current, from the team behind Writulos Scribe. Each post is also available as Markdown: add .md to its address.

Posts

• What Is Documentation Drift, and How Do You Catch It?: Documentation drift is the gap between what your docs say and what your code does. Here is why it happens, how to measure it, and how to stop it in CI.
• How to Fail a Pull Request When the Docs Are Out of Date: A step-by-step guide to a CI check that blocks a merge when documentation has fallen behind the code, using GitHub Actions and branch protection.
• How to Document Python Code: Docstrings and Reference Docs: A practical guide to documenting Python: docstring styles, type hints, module docs, generated reference pages, and keeping all of it current.
• How to Document TypeScript and JavaScript Code: Types, JSDoc and TSDoc comments, generated reference docs, and how to keep TypeScript and JavaScript documentation from going stale as the code changes.
• How to Write Good Code Documentation (A Practical Guide): A practical, no-fluff guide to documenting code your team will actually read: what to include, what to skip, and how to keep docs from going stale.
• How to Automate Code Documentation in Your CI/CD Pipeline: Stop writing docs by hand. Generate and commit fresh documentation automatically on every push, using GitHub Actions or any CI pipeline.
• AI Chat Assistant vs. a Dedicated Code Documentation Tool: A general chat assistant can document code if you prompt it well. A dedicated tool does it consistently in one click. Here's how they compare.