本文へ移動
cccskills
無料GitHub で公開

documentation

Write and maintain technical documentation. Trigger with "write docs for", "document this", "create a README", "write a runbook", "onboarding guide", or when the user needs help with any form of technical writing — API docs, architecture docs, or operational runbooks.

インストール方法を見る

含まれるファイル(1)

  • SKILL.md1.5 KB

SKILL.md(原文)

インストールする前に、エージェントに与えられる指示の中身を確認できます。

Technical Documentation

Write clear, maintainable technical documentation for different audiences and purposes.

Document Types

README

  • What this is and why it exists
  • Quick start (< 5 minutes to first success)
  • Configuration and usage
  • Contributing guide

API Documentation

  • Endpoint reference with request/response examples
  • Authentication and error codes
  • Rate limits and pagination
  • SDK examples

Runbook

  • When to use this runbook
  • Prerequisites and access needed
  • Step-by-step procedure
  • Rollback steps
  • Escalation path

Architecture Doc

  • Context and goals
  • High-level design with diagrams
  • Key decisions and trade-offs
  • Data flow and integration points

Onboarding Guide

  • Environment setup
  • Key systems and how they connect
  • Common tasks with walkthroughs
  • Who to ask for what

Principles

  1. Write for the reader — Who is reading this and what do they need?
  2. Start with the most useful information — Don't bury the lede
  3. Show, don't tell — Code examples, commands, screenshots
  4. Keep it current — Outdated docs are worse than no docs
  5. Link, don't duplicate — Reference other docs instead of copying

レビュー

まだレビューはありません。使ってみた感想をお寄せください。

同じリポジトリのスキル

概要と使いどころ

Run a WCAG 2.1 AA accessibility audit on a design or page. Trigger with "audit accessibility", "check a11y", "is this accessible?", or when reviewing a design for color contrast, keyboard navigation, touch target size, or screen reader behavior before handoff.

日本語の概要は準備中です。原文の説明を表示しています。

TencentCloud/Octop9,4902026年10月15日 更新

使用 akshare-cli 获取中国及全球金融市场数据(1090+ 个函数)。覆盖股票、基金、期货、债券、外汇、宏观经济、指数、期权、新闻等全领域。当用户需要以下任何一种数据时触发此 skill:股票行情、历史K线、实时报价、涨停跌停池、龙虎榜、板块资金流向、基金/ETF净值、期货行情、债券/可转债、外汇汇率、宏观经济指标(GDP/CPI/PMI)、指数数据、期权数据、财经新闻。关键词触发:akshare、股票、行情、K线、基金、期货、外汇、宏观、国债、可转债、涨停、龙虎榜、板块、资金流向、stock data、market data、financial data、A股、港股、美股。即使用户只是随口提到"看看某个股票"或"最近市场怎么样",也应触发。

日本語の概要は準備中です。原文の説明を表示しています。

TencentCloud/Octop9,4902026年10月15日 更新

Create or evaluate an architecture decision record (ADR). Use when choosing between technologies (e.g., Kafka vs SQS), documenting a design decision with trade-offs and consequences, reviewing a system design proposal, or designing a new component from requirements and constraints.

日本語の概要は準備中です。原文の説明を表示しています。

TencentCloud/Octop9,4902026年10月15日 更新

AI 编程工具速查与 60+ 技巧清单——覆盖 Claude Code / Cursor / Codex / Copilot / Aider 等的能力矩阵、核心命令与高频技巧分类。供编程导师在选型与排障时引用。

日本語の概要は準備中です。原文の説明を表示しています。

TencentCloud/Octop9,4902026年10月15日 更新

快速回答普通教育性医学问题与常见误区。默认用一份国内现行权威指南/共识完成轻量核验并立即作答;不用于个体诊疗、处方剂量、精确推荐定位、药品高风险事实、医保监管或跨版本比较。

日本語の概要は準備中です。原文の説明を表示しています。

TencentCloud/Octop9,4902026年10月15日 更新

Review code changes for security, performance, and correctness. Trigger with a PR URL or diff, "review this before I merge", "is this code safe?", or when checking a change for N+1 queries, injection risks, missing edge cases, or error handling gaps.

日本語の概要は準備中です。原文の説明を表示しています。

TencentCloud/Octop9,4902026年10月15日 更新

TencentCloud のスキルをすべて見る

このスキルの問題を報告する