KitScout

Categories › Software Development › Library & API documentation lookup

project-docs

SkillInstall · skills CLI

对任意代码项目生成一套面向新人的循序渐进文档集,输出到 docs/ 目录。含架构、设计思想、语言特性、代码导读、运行时模型、构建、对接、调试、设计规范共 9 篇,支持全部生成 / 只写几篇 / 更新已有文档。当用户提到"生成项目文档"、"新人文档"、"上手文档"、"架构文档"、"代码导读"、"项目理解"、"深入理解项目"、"onboarding 文档"、"给新同事看的文档"时使用。要按用户给的格式写论文章节、项目梳理、重点问题、简历项目描述的,用 codegen-doc。

Install

KitScout test notes

Not tested by KitScout yet. When our harness runs it, pros, cons and the tasks we tried appear here, with the date and evidence.

Similar tools

  • grill-with-docs 323,337 ★
    A relentless interview to sharpen a plan or design, which also creates docs (ADR's and glossary) as we go.
  • research 323,337 ★
    Investigate a question against high-trust primary sources and capture the findings as a Markdown file in the r
  • documentation-and-adrs 117,221 ★
    Records decisions and documentation, and detects when documentation has drifted from the code it describes. Us
  • doc-maintenance 113,505 ★
    Audit README and PRODUCT docs against recent git history for drift and make minimal PR-ready edits. Use when a
  • doc-maintenance 113,505 ★
    Keep project docs aligned with recent code and feature changes — detect drift, update affected pages, and add