docs-from-code
- Repo stars 1
- Author repo claude-skills
Docs From Code
Overview
Translate what the code does into documentation people can actually use.
Core Workflow
- Identify the audience first: developer, operator, customer, reviewer, or teammate.
- Read the code, scripts, config, and tests to extract accurate setup steps, behaviors, constraints, and terminology.
- Organize the document around real user needs such as setup, architecture, usage, troubleshooting, or change impact.
- Add examples and commands only when they are supported by the repo or provided artifacts.
- Tighten for clarity and remove implementation noise that does not help the audience.
Deliver
- Produce docs that are specific, runnable, and easy to scan.
- Include caveats, prerequisites, and common failure points when they matter.
- Update existing docs instead of creating duplicates when a home already exists.
Guardrails
- Do not invent commands, file paths, or guarantees.
- Keep architecture explanations high-signal rather than encyclopedic.
- Prefer the repository's established tone and documentation structure.
- 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
- @00PrabalK00 · 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. Translate what the code does into documentation people can actually use.
Identify the audience first: developer, operator, customer, reviewer, or teammate. Read the code, scripts, config, and tests to extract accurate setup steps, behaviors, constraints, and terminology. Organize the document around real user needs such as setup,…
Produce docs that are specific, runnable, and easy to scan. Include caveats, prerequisites, and common failure points when they matter. Update existing docs instead of creating duplicates when a home already exists.
Do not invent commands, file paths, or guarantees. Keep architecture explanations high-signal rather than encyclopedic. Prefer the repository's established tone and documentation structure.
# Docs From Code
## Overview
Translate what the code does into documentation people can actually use.
## Core Workflow
1. Identify the audience first: developer, operator, customer, reviewer, or teammate.
2. Read the code, scripts, config, and tests to extract accurate setup steps, behaviors, constraints, and terminology.
3. Organize the document around real user needs such as setup, architecture, usage, troubleshooting, or change impact.
4. Add examples and commands only when they are supported by the repo or provided artifacts.
5. Tighten for clarity and remove implementation noise that does not help the audience.
## Deliver
- Produce docs that are specific, runnable, and easy to scan.
- Include caveats, prerequisites, and common failure points when they matter.
- Update existing docs instead of creating duplicates when a home already exists.
## Guardrails
- Do not invent commands, file paths, or guarantees.
- Keep architecture explanations high-signal rather than encyclopedic.
- Prefer the repository's established tone and documentation structure. Author text anchors workflow facts; Fluxly only indexes current sections, terms, files, and commands.
sections -> Overview → Core Workflow → Deliver → Guardrails
terms -> Translate what the code does into documentation people can actually use. · 1. Identify the audience first: developer, operator, customer, reviewer, or teammate. · - Produce docs that are specific, runnable, and easy to scan. · - Do not invent commands, file paths, or guarantees.
files/cmd -> no explicit files or commands
body sha256 -> e7b0daa507dd
Decide Fit First
Design Intent
How To Use It
Boundaries And Review