SkillFeeder › 全部 Skill › 工程开发 › octocode-documentation
重写、校订和重构技术文档，确保准确、清晰且符合 Google 风格指南。
octocode-documentation
octocode-documentation 是 SkillFeeder 收录的Agent Skill，来自 GitHub 仓库 bgauryy/octocode，★ 958。重写、校订和重构技术文档，确保准确、清晰且符合 Google 风格指南。适合技术作者、开源维护者、SRE。场景是工程开发 · 重构架构。能做的事包括生成符合 Google 风格的 README 和 API 参考文档、修复过时、错误或缺失的 runbook 与迁移指南、为代码库添加规范 docstrings 和 Diátaxis 结构。打开 GitHub 自行安装。
能做什么
- 生成符合 Google 风格的 README 和 API 参考文档
- 修复过时、错误或缺失的 runbook 与迁移指南
- 为代码库添加规范 docstrings 和 Diátaxis 结构
原文简介
Use when docs are missing, wrong, stale, or badly written, or need a copyedit against the Google style guide: README, API reference, runbook, CONTRIBUTING, changelog, onboarding, AGENTS.md/CLAUDE.md, ADR, migration guide, Diátaxis or whole-codebase restructure, docstrings, alt text, prose linting. Not for code, commits, or marketing copy. Code investigation → octocode-research; SKILL.md folders →
同场景推荐
- ai-first-engineering所在仓库 affaan-m/ECC，仓库 ★ 300,254建立AI主导开发的团队工程规范与评审机制
- architecture-decision-records所在仓库 affaan-m/ECC，仓库 ★ 300,254自动生成编号ADR文档，记录架构决策的上下文、选项与影响。
- code-review-and-quality所在仓库 addyosmani/agent-skills，仓库 ★ 114,581自动执行五维代码审查并给出合并建议
- code-simplification所在仓库 addyosmani/agent-skills，仓库 ★ 114,581把能跑的代码变清晰，行为零改动
- documentation-and-adrs所在仓库 addyosmani/agent-skills，仓库 ★ 114,581自动生成带决策背景的ADR文档和设计说明
- simplify-codebase所在仓库 tt-a1i/archify，仓库 ★ 95,063自动识别并安全删除死代码、冗余层和过载抽象
- code-documentation所在仓库 bytedance/deer-flow，仓库 ★ 85,194自动生成README、API文档、内联注释等专业代码文档
- find-security-vulnerabilities-in-code所在仓库 usestrix/strix，仓库 ★ 74,698扫描代码库，自动发现真实可利用的安全漏洞并附带 PoC