documentation-from-code
- Repo stars 0
- Author repo skills-registry
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
- Read the codebase structure using
filesystem.list - Identify entry points, public APIs, and key modules
- Read source files to understand functionality
- Extract docstrings, type hints, and comments
- Generate documentation in appropriate format (Markdown, JSDoc, etc.)
- Write documentation files using
filesystem.write - Verify generated docs are accurate and complete
Examples
Example 1: Generate README
Input: "Generate a README for this project" Walkthrough:
- List project root files to understand structure
- Read package.json, Cargo.toml, or similar for metadata
- Read main source files to understand functionality
- Identify installation steps, usage examples, and API overview
- Generate README with sections: Install, Usage, API, Contributing, License
- Write README.md to project root
Example 2: API documentation
Input: "Document the REST API endpoints" Walkthrough:
- Find route definitions in the codebase
- Extract HTTP methods, paths, parameters, and response types
- Read validation schemas for request/response shapes
- Generate OpenAPI/Swagger-style documentation
- Include example requests and responses
<!-- tomevault:4.0:skill_md:2026-05-22 -->Source: daniel-silva-perez/zeus — distributed by TomeVault.
- Fluxly category
- Documentation
- Author-declared agents
- No explicit declaration found; this is not inferred or tested compatibility
- Static check
- 88 / 100 · heuristic scan, not runtime safety proof
- Author / version / license
- @tomevault-io · no license declared
- Fluxly token estimate
- Lean
- Fluxly setup estimate
- Plug-and-play
- External API key
- No requirement detected
- Detected OS requirements
- Unspecified
- Runtime requirements
- Unspecified
- Detected file/system behavior
-
- Read-only
- Write / modify
- Detected network behavior
- Local-only
- Install commands
- None (reference only)
Profile is derived at build time from SKILL.md and install vectors. Subject to drift from author intent.
Heads up: 未限定 allowed-tools,默认拥有全部工具权限。
The current SKILL.md does not define a fixed output example. When you need to create or update documentation from existing code. Generates README files, API documentation, architecture overviews, and inline documentation improvements.
Read the codebase structure using filesystem.list Identify entry points, public APIs, and key modules Read source files to understand functionality
Examples
Input: "Generate a README for this project" Walkthrough: List project root files to understand structure
Input: "Document the REST API endpoints" Walkthrough: Find route definitions in the codebase
# 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 --> Author text anchors workflow facts; Fluxly only indexes current sections, terms, files, and commands.
sections -> When to Use → Procedure → Examples → Example 1: Generate README → Example 2: API documentation
terms -> --- > Source: [daniel-silva-perez/zeus](https://github.com/daniel-silva-perez/zeus) — distributed by [TomeVault](https://tomevault.io).
files/cmd -> filesystem.list · filesystem.write · package.js · README.md · request/response · OpenAPI/Swagger-style · daniel-silva-perez/zeus · github.com/daniel-silva-perez/zeus
body sha256 -> b39b3a698946
Decide Fit First
Design Intent
How To Use It
Boundaries And Review