القائمة
Use when creating or updating in-app help content — tooltips, empty states, contextual panels, help articles — or auditing help coverage, identifiers, and accuracy.
التثبيت باستخدام Codex أو Claude انسخ هذا Prompt والصقه في Codex أو Claude أو مساعد آخر ليراجع صفحة Skill ويثبّتها لك.
استنادا إلى تصنيف SOC المهني
Process raw-extracted JSON files from PDF book extractions into clean, well-structured markdown. Use this skill whenever a user uploads a raw-extracted.json (or similar JSON with metadata and chunks arrays) from a PDF text extraction pipeline, or when they mention cleaning up, formatting, structuring, or organizing extracted book text. Also trigger when the user mentions OCR output, pypdf extraction, book chapters, or converting messy PDF extractions into readable markdown. This skill handles books with varying extraction quality — from clean text to garbled OCR — and adapts its approach accordingly.
This skill should be used when the user invokes /code-documentation, or asks to "write/generate/audit/update documentation", "write a README", "document this API or codebase", "write a tutorial / how-to / runbook", "write user help docs", "generate docstrings", "write an ADR or RFC", "create a changelog", "produce llms.txt or AGENTS.md", or "turn these docs into a doc site". Produces first-class documentation for any audience (end users, API consumers, contributors, operators, evaluators, AI agents) across all four Diátaxis modes, for the full lifecycle — authoring, generating from a codebase, auditing, and maintaining. Emits publish-ready Markdown or structured content for Docusaurus, MkDocs, Sphinx, Starlight, Mintlify, or Volume.
React composition patterns that scale. Use when refactoring components with boolean prop proliferation, building flexible component libraries, or designing reusable APIs. Triggers on tasks involving compound components, render props, context providers, or component architecture.
Use when the user wants to brainstorm blog topics, generate or score article ideas, review/approve content ideas, track article status, or manage editorial planning — including mentions of "content calendar", "editorial calendar", "blog ideas", "article pipeline", "content backlog", or "publishing schedule".
Checklist for auditing architecture contracts in a develop-by-contract environment. Covers the failure modes most commonly found during contract review: status drift, AI-invented decisions, cross-contract fact drift, stale feature references, missing state specs, and business policy gaps.
Use when analyzing, auditing, reviewing, or explaining a codebase, system, or project state — whenever written claims could mix observed fact with interpretation.
| name | help-docs-contract |
| description | Use when creating or updating in-app help content — tooltips, empty states, contextual panels, help articles — or auditing help coverage, identifiers, and accuracy. |
This skill defines the non-negotiable contract for creating in-app help documentation that is contextual, accessible, UI-aware, and verifiably accurate.
It is authoritative and intended to be reused across projects.
This skill applies whenever an agent:
Help content MUST reflect current, observable system behaviour, not intent, roadmap, or assumptions.
Every help unit MUST have exactly one primary intent:
tutorial — guided learninghow_to — goal-oriented stepsexplanation — conceptual understandingreference — lookupHelp units MUST NOT mix intents.
Every help unit MUST have stable identifiers:
doc_id — unique, human-readable, stable once publishedfeature_id — stable feature identifier used for coverage trackingui_anchor_id — stable UI anchor identifier tied to a specific screen or regionIdentifiers MUST be:
Each help unit MUST define:
Help MUST open without leaving the app and MUST offer a safe return path after any UI jump.
Help content and help UI MUST:
Accessibility failures are ship blockers.
Help MUST match UI labels exactly.
Each help unit MUST record:
introduced_at — date or versionlast_verified_at — date or versionverification_scope — what was verifiedHelp that depends on conditional or experimental behaviour MUST be explicitly flagged.
If any ship-blocker rule is violated, the agent MUST:
This skill exists to prevent: