The documentation is a person, and they are on holiday

说明与用途

文档可能会悄悄变得过时，导致团队依赖单个人。部署 Celmis 可实现自动变更检测、重新生成、来源跟踪和错误警报，减少对单个人的依赖。

问题

Documentation can become stale silently, leading new joiners to rely on outdated or missing information and waste time asking a single person for answers.

结果

Documentation staleness is now observable and actionable; failures are reported on dashboards, and missing docs are explicitly listed, reducing dependency on a single person.

工作流

• 1. Register repositories in Celmis. 2. Daily scheduled sweep runs git ls-remote to detect changes. 3. On change, incremental re‑indexing walks git diff and updates reverse index. 4. Notes are regenerated only if source files changed or commit stamp differs. 5. Failed generations raise errors and are visible on a dashboard. 6. Export documentation archives include a MISSING.txt listing repositories with no docs. 7. Provenance blocks record generator, commit, engine, and lookup count for each note.

证据

Hand‑written documentation goes stale silently. There is no event.

来源

A run in which every document failed used to report success, because the markdown folder existed. It now raises.

来源

Exporting every repository's documentation as one archive writes a MISSING.txt listing the repositories that have none.

来源