srstomp/documentation
plugins/pokayokay/skills/documentation/SKILL.md
Create and maintain technical documentation including READMEs, API docs, architecture decision records (ADRs), and user guides. Use this skill when writing project documentation, documenting APIs, recording architectural decisions, creating how-to guides, or establishing documentation standards.
$ install --global
skillsauthnpx skillsauth add srstomp/pokayokay documentationInstall this skill globally with one command. Works with Claude Code, Cursor, and Windsurf.
Security Scan Results
3 of 9 scanners reported clean
Some scanners were skipped, did not run, or reported a non-clean status. Review each row below.
3
Scanners Passed
9
Scanners in report
Clean
TrivyContainer and dependency vulnerability scanner
95%
Clean
SemgrepStatic code analysis for vulnerabilities
95%
Clean
mcp-scan (Snyk)Model Context Protocol security validation
95%
Skipped
Snyk (dep)Open source security scanning
50%
Skipped
Socket.devSupply chain security analysis
50%
Skipped
VirusTotalMulti-engine malware detection
50%
Skipped
CrowdStrikeAdvanced threat intelligence
50%
Skipped
OSV-ScannerOpen Source Vulnerability database check
50%
Skipped
OWASP Dep-Check
50%
Last scanned: Apr 27, 2026, 7:04 AM56.4s7 files scanned
SKILL.md
- name:
- documentation
- description:
- Create and maintain technical documentation including READMEs, API docs, architecture decision records (ADRs), and user guides. Use this skill when writing project documentation, documenting APIs, recording architectural decisions, creating how-to guides, or establishing documentation standards.
Documentation
Create clear, maintainable technical documentation that serves your audience.
Key Principles
- Documentation as code — docs live with code, version with code, review with code
- Audience-first writing — write for who's reading, not what you know
- Maintainability over completeness — inaccurate docs are worse than no docs
- Link to source of truth — don't duplicate information across docs
Quick Start Checklist
- Identify documentation type (README, API docs, ADR, user guide)
- Determine audience (all users, developers, team, contributors)
- Follow type-specific template from references
- Include working examples (test them!)
- Link to related documentation
Documentation Types
| Type | When to Use | Audience | |------|-------------|----------| | README | Project entry point | All users | | API Docs | Endpoint reference | Developers | | ADR | Major decisions | Team/future devs | | User Guide | Task completion | End users |
References
| Reference | Description | |-----------|-------------| | readme-guide.md | README templates, section patterns, badges | | api-docs.md | API documentation patterns, OpenAPI integration | | adr-guide.md | Architecture Decision Record format and workflow | | diagrams.md | Mermaid diagram patterns for common scenarios | | readme-template.md | Template for project README files | | adr-template.md | Template for Architecture Decision Records |
Related Skills
srstomp/worktrees
development
VerifiedTrustedCommunity
Git worktree management for isolated task development
6SKILL.mdUpdated Apr 27, 2026
srstomp/work-session
development
VerifiedTrustedCommunity
Use when starting AI development sessions, resuming interrupted work, managing multi-session projects, or orchestrating work with human checkpoint control (supervised, semi-auto, auto, or unattended modes).
6SKILL.mdUpdated Apr 27, 2026
srstomp/verification-before-completion
testing
VerifiedTrustedCommunity
Use before claiming work is done, fixed, passing, ready to commit, ready to PR, or ready to mark complete. Requires fresh verification evidence and explicit command output before success claims.
6SKILL.mdUpdated Apr 27, 2026
srstomp/testing-strategy
development
VerifiedTrustedCommunity
Use when designing test architecture, building API test suites, validating API contracts, setting up component or E2E testing, managing test data, debugging flaky tests, reviewing coverage strategy, or organizing test files. Covers test pyramid, mocking (MSW), frontend (React Testing Library, Playwright), and CI integration.
6SKILL.mdUpdated Apr 27, 2026