docs from code

Documentation Community

Skill notes

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.

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 profile Runtime and permissions are inferred by Fluxly static checks, not author declarations or runtime test results.
Domain
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
Runtime evidence
Not run; no isolated runtime test evidence is currently recorded
Author / version / license
@00PrabalK00 · no license declared
Token usage
Lean
Setup complexity
Plug-and-play
External API key
Not required
Operating systems
Unspecified (assume cross-platform)
Runtime requirements
No explicit requirements detected
Detected file/system behavior
  • Read-only
  • Write / modify
Network behavior
Local-only
Install commands
None (reference only)

Heads up: Tool permissions are not declared; actual access depends on the runtime.

Author source file SKILL.md

# 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.

Discussion

Powered by GitHub Discussions. Sign in with GitHub to comment, react, or subscribe.