documentation-implementation_skill

Overview

This skill provides domain-specific guidance and practical patterns for producing clear, accurate technical documentation, API references, and user guides. It focuses on validation, clarity standards, and examples that run. Use it to enforce documentation quality and reduce context loss when documenting features tied to persistent AI memory and developer tools.

How this skill works

The skill inspects task tags, existing docs, and implementation code to produce or validate documentation that matches real behavior. It offers validation commands for linting, spell-checking, link checking, and building or previewing documentation sites. It also provides success criteria, common patterns, blocker reports, and a quality checklist to complete documentation tasks reliably.

When to use it

• Creating or updating API references (endpoints, schemas, status codes)
• Writing user guides, tutorials, or README quick starts
• Validating documentation quality before release
• Documenting code, functions, or Kotlin-specific examples
• Preparing docs for workflow automation or persistent-memory features

Best practices

• Test examples and code snippets locally so they run without errors
• Start each doc with a concise overview and prerequisites
• Document inputs, outputs, edge cases, and authentication clearly
• Use linting, spell checks, and link checks as part of CI
• Keep sentences short, use active voice, and define terms on first use

Example use cases

• Produce an API endpoint page showing path, request body, responses, and curl examples
• Write a README with installation, quick start, configuration options, and contributing notes
• Create a user guide for enabling authentication or integrating persistent memory
• Validate a docs site build, fix broken links, and run a live preview
• Report blockers using the provided template when implementation or assets are missing