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

documentation

Canonical documentation capability for audit, drift, validate, and author modes in hve-core.

インストール方法を見る

含まれるファイル(10)

  • SKILL.md4.8 KB
  • references/accessibility-checks.md947 B
  • references/code-doc-mapping.md3.8 KB
  • references/content-sensitivity.md1.1 KB
  • references/conventions.md865 B
  • references/coverage-method.md1.0 KB
  • references/rai-guardrails.md815 B
  • references/validation-toolchain.md2.5 KB
  • templates/guide.md569 B
  • templates/reference.md407 B

SKILL.md(原文)

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

documentation

Overview

This skill provides the shared documentation capability used by the Documentation agent. It centralizes the durable knowledge for audit, drift, validate, and author flows in a single package so thin wrappers can load mode-specific guidance instead of embedding capability prose inline.

Mode map

The Documentation agent should load the relevant skill sections by mode:

ModePrimary load targetsNotes
auditreferences/conventions.md, references/coverage-method.md, references/validation-toolchain.md, references/content-sensitivity.mdReplaces the former Doc Ops workflow with a skill-driven audit loop.
driftreferences/conventions.md, references/code-doc-mapping.md, references/content-sensitivity.mdUses the repo-local mapping table and drift heuristics.
validatereferences/validation-toolchain.md, references/accessibility-checks.md, references/content-sensitivity.md, references/rai-guardrails.mdRuns docs validation and escalates formal review when needed.
authortemplates/guide.md, templates/reference.md, references/conventions.md, references/accessibility-checks.md, references/content-sensitivity.md, references/rai-guardrails.mdProduces narrative or reference docs with the repository's documented conventions.

Success criteria

For audit and validate modes, record results for all applicable local-safe checks and record existing CI status separately. Keep each CI-owned check that did not run as Pending CI, Skipped, Deferred, or Unavailable; do not report it as Passed.

Non-goals

This skill does not author ADRs, BRDs, PRDs, or other planning artifacts. It also does not embed accessibility, RAI, or security standards logic inline; it points to the dedicated reference files and routes formal assessment to the appropriate planner when the scenario requires it.

Working conventions

  • Prefer existing repository instructions and scripts over duplicated prose.
  • In audit and validate modes, run local-safe checks by default and summarize existing CI status separately. Invoke a CI-owned lane locally only when the task specifically asks to reproduce that named lane.
  • Treat browser installation, model or moderation environments, services, credentials, and interactive UI as separate prerequisites rather than automatic failure recovery.
  • Keep documentation changes factual and scoped to the current task.
  • Use the reference files below for mode-specific methods, heuristics, and checklists.
  • Escalate to planners for formal accessibility, RAI, or security review if the work requires a specialist assessment.

Stop rules

For audit and validate modes, stop after recording local-safe results and any separate CI evidence. Report missing specialized setup or required CI evidence separately; do not infer it, provision it automatically, or report it as passed.

Session tracking

Write session state to .copilot-tracking/documentation/ using a {{YYYY-MM-DD}}-session.md file for the run, following the standard session file conventions.

Reference files

  • references/conventions.md — Synthesis of the repository's markdown, writing-style, and Docusaurus conventions.
  • references/code-doc-mapping.md — Code-to-documentation mapping table and drift heuristics.
  • references/coverage-method.md — Gap and coverage analysis method for audit mode.
  • references/validation-toolchain.md — Validation command catalog and result interpretation.
  • references/accessibility-checks.md — Inline documentation checks and handoff triggers.
  • references/content-sensitivity.md — Pre-publish PII, secrets, confidentiality, and AI-disclosure checks.
  • references/rai-guardrails.md — Injection-boundary, attribution, human-review, and disclaimer guidance.

Templates

  • templates/guide.md — Structure template for narrative guides and how-to pages.
  • templates/reference.md — Structure template for reference and API-style documentation.

レビュー

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

同じリポジトリのスキル

概要と使いどころ

Consolidated accessibility skill entrypoint for WCAG 2.2, ARIA Authoring Practices, cognitive accessibility, Section 508, EN 301 549, design intent verification, and the Accessibility Planner workflow.

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

microsoft/hve-core1,5182026年10月11日 更新

Build, refresh, report, or probe an accessibility coverage matrix across criteria, surfaces, and evidence methods. Use when assessing coverage with the accessibility runtime harness and generated evidence bundle.

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

microsoft/hve-core1,5182026年10月11日 更新

Authoring skill for Architecture Decision Records (ADRs) supporting capture, from-planner-handoff, and adopt-template entry modes with selectable Y-Statement or MADR v4.0.0 output templates, supersession lineage, and ASR trigger evaluation.

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

microsoft/hve-core1,5182026年10月11日 更新

Authoring conventions for exploratory data analysis notebooks and analytical dashboards, covering section sequence, visualization selection, scale thresholds, caching and state, and dashboard validation budgets. Use when composing or reviewing an EDA notebook, an analytical dashboard, or a dashboard test pass.

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

microsoft/hve-core1,5182026年10月11日 更新

Architecture diagram authoring for cloud infrastructure and declared data catalogs. Use when rendering Azure IaC or DS_CATALOG_V1 relationships as caller-selected ASCII or Mermaid diagrams.

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

microsoft/hve-core1,5182026年10月11日 更新

Create a durable Architecture Review Record from a confirmed System Architecture Reviewer scope, evidence, pillar analysis, trade-offs, and dispositions

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

microsoft/hve-core1,5182026年10月11日 更新

microsoft のスキルをすべて見る

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