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

common-documentation

Write effective code comments, READMEs, and technical documentation following intent-first principles. Use when adding comments, writing docstrings, creating READMEs, or updating any documentation.

インストール方法を見る

含まれるファイル(3)

  • SKILL.md1.7 KB
  • evals/evals.json2.2 KB
  • references/implementation.md224 B

SKILL.md(原文)

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

Documentation Standards

Priority: P2 (MEDIUM)

1. Intent-First Comments

  • Explain "Why" logic exists. Avoid "What" mechanics.
  • Use triple-slash (Dart/Swift) or JSDoc (TS/JS) for public members.
  • Delete commented-out code. Use Git history.
  • Format: TODO(username): description. Link tickets.
  • For retry backoff, explain that jitter prevents the thundering herd; document intent rather than restating the delay calculation.

2. README Structure

  • Mission: Project purpose (one sentence).
  • Onboarding: Prerequisites, installation, usage (exact).
  • Maintenance: Document inputs/outputs, known quirks, fixes.
  • Sync: Documentation ships with feature.

3. ADRs & Architecture

  • ADRs: Document rationale for system changes in docs/adr/.
  • Docstrings: Include Args, Returns, and Usage examples (>>>).
  • Diagrams: Use Mermaid.js inside Markdown.

4. API Docs

  • Use Swagger/OpenAPI for REST.
  • Provide copy-pasteable examples for endpoints.
  • Define contract before implementation.

Anti-Patterns

  • No "what" comments: Explain intent. Refactor mechanics.
  • No orphan TODOs: Require owner and ticket.
  • No stale docs: Document during development.

Canonical response anchors

When this skill applies, preserve the following domain terminology or equivalent concrete examples in the answer when relevant:

  • JSDoc
  • Usage
  • why

レビュー

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

同じリポジトリのスキル

概要と使いどころ

Upgrade an Android project to Android Gradle Plugin (AGP) 9. Use when migrating to AGP 9, updating Gradle build files, migrating to built-in Kotlin, or adopting the new AGP DSL.

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

HoangNguyen0403/agent-skills-standard5732026年10月12日 更新

Apply Clean Architecture layering, modularization, and Unidirectional Data Flow in Android projects. Use when setting up project structure, placing code in layers, configuring feature/core modules, or implementing UDF patterns; defer Compose state and ViewModel/StateFlow implementation to their specific skills.

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

HoangNguyen0403/agent-skills-standard5732026年10月12日 更新

Implement WorkManager and background processing correctly on Android. Use when creating Worker classes, scheduling tasks, choosing between WorkManager and Foreground Services, or setting up Hilt in workers; defer FCM and notification delivery to android-notifications.

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

HoangNguyen0403/agent-skills-standard5732026年10月12日 更新

Build high-performance declarative UI with Jetpack Compose. Use when writing Composable functions, optimizing recomposition, hoisting state, or working with LazyColumn and side effects; defer deep-link and navigation routing to android-navigation.

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

HoangNguyen0403/agent-skills-standard5732026年10月12日 更新

Migrate an Android XML View to Jetpack Compose following a structured 10-step workflow. Use when converting XML layouts to Compose, setting up Compose in an existing View-based project, or incrementally adopting Compose.

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

HoangNguyen0403/agent-skills-standard5732026年10月12日 更新

Write correct coroutine scopes, lifecycle collection, and dispatcher injection in Android production code. Use for suspend functions, coroutine scopes, and dispatcher mechanics; defer ViewModel StateFlow/LiveData architecture, Fragment lifecycle recipes, persistence/notifications, and unit-test recipes to their specific skills.

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

HoangNguyen0403/agent-skills-standard5732026年10月12日 更新

HoangNguyen0403 のスキルをすべて見る

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