doc-generator

# Documentation Generator Documentation must be grounded in specific claims rather than abstract adjectives. We avoid filler phrases like "In today's fast-paced world" and focus on delivering useful information directly. Each claim should be supported by evidence, such as specific version numbers or request rates, rather than vague descriptors like "comprehensive." ## Core Writing Principles We prioritize authorial perspective and active voice to maintain a consistent team tone. This involves explaining the reasoning behind technical choices, such as selecting one database over another, rather than providing neutral boilerplate. Bullets should be used sparingly for actionable summaries; multi-line bullet waterfalls should be converted to short paragraphs to preserve nuance. ### Vocabulary and Style Avoid business jargon and linguistic tics like mirrored sentence structures or excessive em dashes. We use the imperative mood for docstrings (e.g., "Validate input") and strictly avoid humanizing non-living constructs like code. | Instead of | Use | |------------|-----| | fallback | default, secondary | | leverage | use | | utilize | use | | facilitate | help, enable | | comprehensive | thorough, complete | ### 9. Limit Humanizing Constructs "Lives under," "speaks to," and similar phrases only make sense for living things. ### 10. Imperative Mood for Docstrings "Validate" not "Validates" (per PEP 257, pydocstyle, ruff). ## Required TodoWrite Items 1. `doc-generator:sco...