skills.rest
bgauryy
bgauryyCOMMUNITY
Explore all skills by this author →
GitHub

octocode-documentation

Write and lint technical documentation against the Google developer documentation style guide.

921|75|Updated Jun 5, 2025
Search Tags:#ADR#Technical Writing#Documentation#Diataxis#Agents.md#markdown linting#Google style guide
One-click install
npx skills add https://github.com/bgauryy/octocode-mcp --skill octocode-documentation
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: octocode-documentation
Source: https://github.com/bgauryy/octocode-mcp/tree/main/skills/octocode-documentation
Command: npx skills add https://github.com/bgauryy/octocode-mcp --skill octocode-documentation

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) and assets (resource) components.

What problem does it solve?

Documentation is often missing, stale, factually wrong, or stylistically inconsistent, and manually enforcing the Google developer documentation style guide across READMEs, API references, runbooks, and agent instruction files is slow and error-prone.

Core Features & Use Cases

  • Five documentation modes: agent-docs (AGENTS.md/CLAUDE.md), human-docs (Diátaxis tutorials, how-tos, reference, explanation), ADRs, multi-file codebase packs, and style-pass copyedits, each with a defined research-to-verify route.
  • Complete Google style guide coverage: 23 reference files restate every guide topic with upstream page links, plus a 597-entry word list as TSV data for instant term verdicts.
  • Deterministic style linting: scripts/style-lint.mjs runs 36 Markdown checks in ERROR/WARN/INFO levels (sentence case, vague link text, missing alt text, non-inclusive terms, time-anchored wording, passive voice), with per-line suppression and a self-test mode.
  • Use Case: Ask the agent to copyedit a docs folder; it runs the linter, fixes each finding using the owning style reference, verifies claims against the repository, and marks unverifiable facts instead of inventing them.

Quick Start

Ask the agent to review and copyedit the README and docs folder against the Google style guide, fixing lint findings and flagging any claims it cannot verify in the repository.

Frequently Asked Questions about octocode-documentation

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I lint Markdown docs against the Google style guide?▼

Run node scripts/style-lint.mjs with your file or directory paths. It reports ERROR, WARN, and INFO findings with rule IDs and fixes, exits 1 on ERROR, and supports --json, --strict, --only, and --skip flags.

How do I write an AGENTS.md file for coding agents?▼

Use the agent-docs mode, which follows the agents.md spec: build an index of exact commands from manifests and CI, an External References table, and key conventions in under 60 lines. Symlink CLAUDE.md to AGENTS.md rather than maintaining divergent copies.

Does the style linter check formats other than Markdown?▼

No, style-lint.mjs covers Markdown files only (.md, .mdx, .markdown). Docstrings, HTML, and UI strings must be hand-checked against the same style references, which the skill's style-pass workflow describes.

How do I suppress a style-lint rule for one line?▼

Add an HTML comment: <!-- style-lint: ignore-line rule-id --> to mute named rules on that line, or <!-- style-lint: ignore-file --> to skip a file found by directory recursion. Directives inside code spans stay inert so pages can document them.

How do I check if a word is allowed by the Google style guide?▼

Grep the 597-entry data file: grep -iP "^term\t" assets/google-word-list.tsv returns the term's verdict (dont-use, avoid, caution, usage) and guidance. Run scripts/refresh-word-list.mjs --dry-run to check drift against the live guide.

When should I not use this documentation skill?▼

Skip it for pure code investigation with no docs deliverable (use octocode-research), for authoring SKILL.md files (use octocode-skills), and for marketing copy. If the project has its own documented style guide, that guide takes precedence.

Related Skills

Explore More Software Engineering Skills→
opzero1opzero1
3

verification-before-completion

Require verifiable evidence before marking tasks complete.

Official
Intermediate
MonumentalSystemsMonumentalSystems
17

documentation-tools

Design documentation stacks with static generators, versioning, and CI/CD deployments.

Official
Advanced
Everyone-Needs-A-CopilotEveryone-Needs-A-Copilot
13

link-validation

Validate Markdown links, anchors, and cross-references across repository files.

Official
Basic
modu-aimodu-ai
1.2k

moai-docs-generation

Generates API references, user guides, and documentation sites using Sphinx, MkDocs, TypeDoc, and OpenAPI.

Official
Intermediate