Enforce standards for READMEs, changelogs, and API references.
npx skills add https://github.com/iannil/code-coder --skill documentation-iannil
Please help me install this Agent Skill. Skill: documentation Source: https://github.com/iannil/code-coder/tree/main/packages/ccode/src/skill/builtin/documentation Command: npx skills add https://github.com/iannil/code-coder --skill documentation-iannil
This Skill provides a comprehensive framework for creating clear, concise, and maintainable technical documentation, ensuring consistency and quality across all project materials.
Follow the documentation standards to write a clear README file for your project.
High-intent search queries and answers about installing and using this skill.
Best practices for writing a README file require establishing clear, concise, and structured documentation standards. This ensures project materials are easily scannable, specific, and maintainable for users and new developers.
To structure a changelog for API documentation, apply standardized writing guidelines that enforce consistency and quality. This framework ensures changes are clearly recorded, concise, and specific for easy tracking.
Writing runnable code examples for technical documentation involves setting strict standards for completeness and outlining common error scenarios. This ensures examples are practical, clear, and easily understood by users.
A technical documentation maintenance checklist should include review triggers, documentation debt tracking, and a pre-publication checklist. This ensures your READMEs and API references remain accurate over time.
Yes, this documentation framework supports tracking documentation debt by outlining review triggers and maintenance practices. This ensures your API references and changelogs remain clear and maintainable.
StrategicMilkApply writing standards to docstrings, comments, markdown, and changelogs in Python codebases.
ZJU-REALBuild and publish accessible websites from user ideas to hosted URLs.
carbon-languageEnforce Carbon project code style across Bazel, C++, Carbon, Markdown, and Python files.
RedWoodOGGenerate README, API references, and architecture docs from codebases.
