martinffx/code-docs
skills/code-docs/SKILL.md
Documentation generation for code projects. Use when updating docs, writing README, generating API docs, creating changelog, or when the user mentions documentation, docs, readme, api docs, or any documentation task.
$ install --global
skillsauthnpx skillsauth add martinffx/claude-code-atelier code-docsInstall 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: May 24, 2026, 6:12 AM17.2s4 files scanned
SKILL.md
- name:
- code-docs
- description:
- >
- user-invocable:
- false
Code Docs
Documentation generation and maintenance for code projects.
When to Document
Always update docs when:
- Adding new features
- Changing existing behavior
- Updating configuration
- Breaking changes
Docs should live:
- Near the code (docstrings, comments)
- In the repo (README, docs folder)
- Generated (API docs, type docs)
Doc Types
README
Project overview, setup, usage. See references/readme-structure.md
Template:
# Project Name
Brief description (one line).
## Quick Start
3-5 commands to get running.
## Installation
Detailed setup steps.
## Usage
Code examples.
## API
Link to full API docs.
## Contributing
How to contribute.
## License
API Documentation
See references/api-docs.md for:
- TypeDoc (JavaScript/TypeScript)
- Sphinx (Python)
- godoc (Go)
- JSDoc (JavaScript)
Changelog
See references/changelog.md for Keep a Changelog format.
Sections:
- Added
- Changed
- Deprecated
- Removed
- Fixed
- Security
Architecture Docs
See references/architecture-docs.md for:
- ADRs (Architecture Decision Records)
- Diagrams
- System overviews
Generation Commands
TypeScript/JavaScript
# TypeDoc
npx typedoc --out docs src/index.ts
# JSDoc
npx jsdoc src/ -d docs/
# API Extractor (monorepos)
npx api-extractor run
Python
# Sphinx
sphinx-build -b html docs docs/_build
# pdoc
pdoc --output-dir docs src/
# mkdocs
mkdocs serve
Go
# godoc
godoc -http=:6060
# swag (OpenAPI from comments)
swag init -g cmd/server/main.go
Workflow
1. Identify what needs docs
- New files/features → update relevant doc
- Breaking change → update CHANGELOG
- New public API → update API docs
2. Generate/Update
- Run doc generators
- Update manual docs
- Verify examples work
3. Verify
- Links work
- Examples run
- Build passes
4. Commit
docs: update API documentation
Generated via typedoc.
Added: new /users endpoint
Changed: authentication section
Best Practices
- Write docs in the code - Docstrings, comments
- Generate where possible - Don't duplicate
- Keep README minimal - Link to detailed docs
- Version with code - Docs in same repo/PR
- Test examples - Ensure they run
Related Skills
martinffx/oracle-security
development
VerifiedTrustedCommunity
Security architecture and threat modeling knowledge. Auto-invokes when designing features that handle untrusted data, authentication, authorization, external integrations, file uploads, or sensitive data. Provides risk assessment frameworks, trust boundary analysis, and security design principles — not implementation code.
25SKILL.mdUpdated May 24, 2026
martinffx/oracle-doubt
testing
VerifiedTrustedCommunity
Adversarial review of non-trivial decisions using fresh-context scrutiny. Use when correctness matters more than speed, when stakes are high (production, security-sensitive logic, irreversible operations), or before committing significant architectural or implementation choices.
25SKILL.mdUpdated May 24, 2026
martinffx/code-handoff
development
VerifiedTrustedCommunity
Compact the current conversation into a handoff document for another agent to pick up.
25SKILL.mdUpdated May 24, 2026
martinffx/oracle-grillme
testing
VerifiedTrustedCommunity
Socratic interrogation of plans against the project's domain model and documented decisions. Use when the user wants to stress-test a plan, clarify terminology, or validate assumptions against existing domain language. Updates CONTEXT.md and ADRs inline as decisions crystallise.
25SKILL.mdUpdated May 23, 2026