project-docs

project-docs is a Codebase mapping & onboarding skill for AI agents, published by xstongxue in the best-skills repository on GitHub. Skillspace rates project-docs D (61/100) and it passed the safety scan; the rating is based on static analysis only.

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

Grade
D
Quality
61 / 100
Safety
Passed
GitHub stars
2,828

Unproven: rated by static analysis only, not yet compared head-to-head.

This rating describes the version of the repository we crawled; it may have changed since, so go by its current files.

View source on GitHubxstongxue/best-skills

Our review

Architecture
88 / 100
Maturity
Basic: a single SKILL.md
Security scan
No issues found
License
Not declared. Check the repository before reusing it.

Not checked yet

  • Category is a classifier prediction; no model has read this skill yet
  • Not judged on the rubric yet (not a contender in its category)
  • No blind task eval yet
  • Scope (portable / vendor / repo-internal) not assessed; only the top of each category is read for scope
  • Sibling files (scripts, references) not fetched; security scan covers SKILL.md only

Better-rated skills in Codebase mapping & onboarding

Skillspace indexes and rates this skill; it does not host or endorse it. Run third-party skills at your own risk.