OpenSmartRoute

documentation-engineer - Skill - OpenSmartRoute

Skillv1.0.0

documentation-engineer

Name: documentation-engineer
Author: zhaono1

Technical documentation expert for creating clear, comprehensive documentation. Use when user asks to write docs, create README, or document code.

by zhaono1(0) 0 installs

Free

Free account. Installing gives you the manifest plus copy-paste snippets.

See reviews

About

Imported from zhaono1/agent-playbook (skills/documentation-engineer/SKILL.md) via skills.sh. Install upstream with npx skills add zhaono1/agent-playbook --skill documentation-engineer. Copyright stays with the author.

Documentation Engineer

Expert in creating clear, comprehensive, and maintainable technical documentation.

When This Skill Activates

Activates when you:

Ask to write documentation
Request README creation
Mention "docs" or "document this"
Need API documentation

Documentation Types

1. README

Every project should have a README with:

# Project Name

Brief description (what it does, why it exists)

## Quick Start

Installation and usage in 3 steps or less.

## Installation

Detailed installation instructions.

## Usage

Examples of common usage patterns.

## Configuration

Environment variables and configuration options.

## Development

How to run tests, build, and develop locally.

## Contributing

Guidelines for contributors.

## License

License information.

2. API Documentation

For each endpoint/function:

Description: What it does
Parameters: Name, type, required/optional, description
Return value: Type and structure
Errors: Possible errors and conditions
Examples: Usage examples

3. Code Comments

Comment why, not what:

// Bad: Sets the count to zero
count = 0;

// Good: Reset count for new measurement cycle
count = 0;

// Bad: Check if user is admin
if (user.role === 'admin') {

// Good: Only admins can bypass approval workflow
if (user.role === 'admin') {

4. Architecture Documentation

System overview
Component relationships
Data flow
Design decisions
Trade-offs considered

Documentation Principles

Be Clear: Use simple, direct language
Be Concise: Respect the reader's time
Be Accurate: Keep docs in sync with code
Be Complete: Cover all public interfaces
Be Current: Update docs when code changes

Writing Guidelines

Headings

Use sentence case for headings
Start with a verb or noun
Be descriptive

Code Examples

Show before/after when appropriate
Include import statements
Show expected output
Handle edge cases

Diagrams

Use Mermaid for flowcharts and sequences
Keep diagrams simple
Add a title and legend

Documentation Checklist

README

Code Docs

All public functions documented
Parameters and returns documented
Examples provided for complex functions
Edge cases documented

API Docs

Scripts

Generate documentation structure:

python3 scripts/generate_docs.py --name <service-name> --output docs/README.md

Validate documentation:

python3 scripts/validate_docs.py --input docs/README.md

References

references/readme-template.md - README template
references/api-template.md - API documentation template
references/style-guide.md - Documentation style guide

Installed into a catalogue, chosen by a router

Install documentation-engineer and it becomes one more candidate the router can pick - when it fits.

A listing is a routing target with a manifest: what it does, which domains it covers, what it costs and who publishes it. Once installed it sits beside your own models and tools, is scored like any other candidate for each request, and shows up in the trace when it wins. Ratings come from workspaces that installed it, one per account.

Photo: RDNE Stock project

Use it

Copy one of these into your project. Installing also returns the manifest and these snippets.

# after Install: the listing is in your workspace's routing pool - a plan picks it for its slot
curl -s -X POST https://api.opensmartroute.ai/api/v1/route -H 'Authorization: Bearer $OSR_API_KEY' -H 'Content-Type: application/json' -d '{"text": "...", "plan": true}'

Manifest

An Open Capability Manifest: the router reads it to know what this does, what it costs and when to pick it.

zhaono1-agent-playbook-documentation-engineer.ocm.jsonjson

{
  "ocm": "1",
  "id": "zhaono1-agent-playbook-documentation-engineer",
  "kind": "skill",
  "name": "documentation-engineer",
  "description": "Technical documentation expert for creating clear, comprehensive documentation. Use when user asks to write docs, create README, or document code.",
  "publisher": "zhaono1",
  "version": "1.0.0",
  "capabilities": {
    "domains": [
      "coding"
    ],
    "tags": [
      "skill-md",
      "skills-sh"
    ],
    "languages": [
      "en"
    ]
  },
  "quality_prior": 0.6,
  "examples": [
    "Technical documentation expert for creating clear, comprehensive documentation. Use when user asks to write docs, create README, or document code."
  ],
  "primary": false,
  "metadata": {
    "source": {
      "provider": "skills.sh",
      "repository": "https://github.com/zhaono1/agent-playbook",
      "path": "skills/documentation-engineer/SKILL.md",
      "ref": "HEAD",
      "url": "https://www.skills.sh/zhaono1/agent-playbook/documentation-engineer",
      "key": "zhaono1/agent-playbook/skills/documentation-engineer/SKILL.md"
    },
    "allowed_tools": [
      "Read,",
      "Write,",
      "Edit,",
      "Grep,",
      "Glob,",
      "WebFetch,",
      "WebSearch"
    ]
  },
  "instructions": "# Documentation Engineer\n\nExpert in creating clear, comprehensive, and maintainable technical documentation.\n\n## When This Skill Activates\n\nActivates when you:\n- Ask to write documentation\n- Request README creation\n- Mention \"docs\" or \"document this\"\n- Need API documentation\n\n## Documentation Types\n\n### 1. README\nEvery project should have a README with:\n\n```markdown\n# Project Name\n\nBrief description (what it does, why it exists)\n\n## Quick Start\n\nInstallation and usage in 3 steps or less.\n\n## Installation\n\nDetailed installation instructions.\n\n## Usage\n\nExamples of common usage patterns.\n\n## Con",
  "cost": {
    "context_tokens": 798
  }
}

Fetch it by URL: GET /api/v1/registry/zhaono1-agent-playbook-documentation-engineer/manifest?version=1.0.0