来自代码的文档
- 作者仓库星标 0
- 作者仓库 skills-registry
- 领域
- 文档
- 作者声明的智能体
- 未找到明确声明;不据此推断已兼容或已测试
- 静态检查
- 88 / 100 · 启发式扫描,不代表运行安全
- 运行环境证据
- 未执行;当前没有隔离运行测试证据
- 作者 / 版本 / 许可证
- @tomevault-io · 未声明许可证
- 上下文用量评级
- 低消耗
- 接入复杂程度
- 即装即用
- 是否需要外部接口密钥
- 不需要
- 兼容的系统
- 未声明(默认跨平台)
- 运行环境要求
- 未检出明确要求
- 检测到的文件与系统行为
-
- 只读
- 允许写入 / 修改
- 网络行为
- 仅限本地
- 安装命令数
- 无(仅作为资料)
需要注意: 未声明工具权限范围;实际权限由运行环境决定。
# Documentation from Code Skill
## When to Use
When you need to create or update documentation from existing code. Generates README files,
API documentation, architecture overviews, and inline documentation improvements.
## Procedure
1. Read the codebase structure using `filesystem.list`
2. Identify entry points, public APIs, and key modules
3. Read source files to understand functionality
4. Extract docstrings, type hints, and comments
5. Generate documentation in appropriate format (Markdown, JSDoc, etc.)
6. Write documentation files using `filesystem.write`
7. Verify generated docs are accurate and complete
## Examples
### Example 1: Generate README
Input: "Generate a README for this project"
Walkthrough:
1. List project root files to understand structure
2. Read package.json, Cargo.toml, or similar for metadata
3. Read main source files to understand functionality
4. Identify installation steps, usage examples, and API overview
5. Generate README with sections: Install, Usage, API, Contributing, License
6. Write README.md to project root
### Example 2: API documentation
Input: "Document the REST API endpoints"
Walkthrough:
1. Find route definitions in the codebase
2. Extract HTTP methods, paths, parameters, and response types
3. Read validation schemas for request/response shapes
4. Generate OpenAPI/Swagger-style documentation
5. Include example requests and responses
---
> Source: [daniel-silva-perez/zeus](https://github.com/daniel-silva-perez/zeus) — distributed by [TomeVault](https://tomevault.io).
<!-- tomevault:4.0:skill_md:2026-05-22 -->
章节与文件索引
按说明文件中的顺序排列。
何时使用
程序
示例 1:生成自述文件
示例 2:API 文档
文件/命令 -> filesystem.list · filesystem.write · package.js · README.md · request/response · OpenAPI/Swagger-style · daniel-silva-perez/zeus · github.com/daniel-silva-perez/zeus
内容校验值 -> b39b3a698946
当前原文的自动摘译,尚未人工审校。
何时使用
当您需要从现有代码创建或更新文档时。生成自述文件、API 文档、架构概述和内联文档改进。
程序
使用
filesystem.list阅读代码库结构 识别入口点、公共 API 和关键模块 阅读源文件以了解功能 提取文档字符串、类型提示和注释 以适当的格式生成文档(Markdown、JSDoc 等)示例 1:生成自述文件
输入:“为此项目生成自述文件” 演练:列出项目根文件以了解结构 阅读 package.json、Cargo.toml 或类似的元数据 阅读主要源文件以了解功能
示例 2:API 文档
输入:“记录 REST API 端点”演练:在代码库中查找路由定义 提取 HTTP 方法、路径、参数和响应类型 读取请求/响应形状的验证架构