Skip to content
cccskills
FreePublished on GitHub

codex-role-docs

Use for role-scoped FE/BE/DevOps/Admin/QA project docs under .codex/project-docs to preserve micro-context across long projects.

The English summary is being prepared. Showing the original description.

See how to install

Files included (10)

  • SKILL.md3.2 KB
  • agents/openai.yaml270 B
  • scripts/build_role_docs_index.py3.5 KB
  • scripts/check_role_docs.py11.3 KB
  • scripts/init_role_docs.py5.7 KB
  • scripts/update_role_docs.py5.4 KB
  • templates/adr-template.md481 B
  • templates/project-brief-template.md606 B
  • templates/role_docs_manifest.json10.1 KB
  • templates/role-doc-template.md426 B

SKILL.md (original)

Review the instructions the agent will receive before you install.

TL;DR

Use this skill when a project needs durable FE/BE/DevOps/Admin/QA context. Initialize only the project brief by default; create role folders for the roles this project actually needs, then keep those docs current as code changes.

Codex Role Docs

Activation

  1. Activate on $role-docs, $init-docs, or $check-docs.
  2. Activate when the user asks for project docs, role docs, technical documentation, architecture notes, API docs, UI/UX docs, runbooks, or durable context.
  3. Activate during long-running projects where micro-context can be lost across sessions.
  4. Auto-use with agent personas when a role-owned file changes.

Core Rule

Role docs are project-local artifacts, not always-loaded context. Read only the role docs needed for the current task, then update the same docs before completion when code behavior, contracts, architecture, UI patterns, deployment, admin flows, or tests changed.

Commands

  • Initialize minimal docs: init_role_docs.py --project-root <path> (project brief + ADR template only)
  • Initialize selected roles: init_role_docs.py --project-root <path> --roles frontend,qa
  • Initialize every role only when needed: init_role_docs.py --project-root <path> --roles all
  • Update one doc: update_role_docs.py --project-root <path> --role <role> --doc <doc-id> --summary <text> --files <csv>
  • Check impact: check_role_docs.py --project-root <path> --changed-files <csv>
  • Rebuild index: build_role_docs_index.py --project-root <path>
  • See skills/.system/REGISTRY.md for full script paths.

Role Ownership

RoleOwns
frontend-specialistfrontend/FE-*, admin UI flows, dashboards, reports
backend-specialistbackend/BE-*, admin permissions, contracts, data management
devops-engineerdevops/DO-*
test-engineerqa/QA-*
security-auditorauth/security, permissions, audit-log docs
plannerproject brief, ADR template, admin scope

Update Discipline

  1. Before editing, check whether relevant docs exist under .codex/project-docs/.
  2. If missing and the task is project setup or planning, run $init-docs.
  3. After code changes, run $check-docs or map changed files manually.
  4. Update only the docs owned by the active agent's role.
  5. Keep entries factual: decision, source files, constraints, risks, verification.
  6. Do not block completion only because docs are missing unless the user explicitly made docs mandatory.

Generated Structure

  • Always: PROJECT-BRIEF.md and decisions/ADR-0001-template.md.
  • On request: frontend/FE-*.md, backend/BE-*.md, devops/DO-*.md, admin/AD-*.md, and/or qa/QA-*.md for the selected roles.
  • index.json is created only when the index builder runs.

Resources

  • templates/role_docs_manifest.json: canonical role docs, owners, and doc metadata.
  • templates/project-brief-template.md: project-level context template.
  • templates/role-doc-template.md: shared role-document template.
  • templates/adr-template.md: decision record template.

Reviews

No reviews yet. Tell others what you thought.

Comments

No login needed. Share how it worked for you, ask a question, or note where it did not run.

No comments yet. Be the first to write one.

Comments are published right away. Do not include personal information such as email addresses or phone numbers. Up to 2 URLs.

0 / 1,000 characters

This form is protected by reCAPTCHA, and the Google Privacy Policy and Terms of Service apply.

More skills from this repository

Use when implementation is complete, all tests pass, and you need to decide how to integrate the work — guides completion of development work by presenting structured options for merge, PR, or cleanup

The English summary is being prepared. Showing the original description.

Bang-isme/CodexAI---Skills10Updated Oct 5, 2026

Use when a project has 50+ files, missing context, or explicit $codex-genome request; generates multi-layer project context to reduce hallucination.

The English summary is being prepared. Showing the original description.

Bang-isme/CodexAI---Skills10Updated Oct 5, 2026

Use for DESIGN.md visual identity contracts; author, scaffold, lint, diff, and export design contracts with the upstream spec and CLI.

The English summary is being prepared. Showing the original description.

Bang-isme/CodexAI---Skills10Updated Oct 5, 2026

Use when the task involves reading, creating, or editing `.docx` documents, especially when formatting or layout fidelity matters; prefer `python-docx` plus the bundled `scripts/render_docx.py` for visual checks.

The English summary is being prepared. Showing the original description.

Bang-isme/CodexAI---Skills10Updated Oct 5, 2026

Use when code changes may require documentation updates; maps git diff to candidate docs without auto-editing documentation.

The English summary is being prepared. Showing the original description.

Bang-isme/CodexAI---Skills10Updated Oct 5, 2026

Use for documents, reports, memos, guides, academic papers, or formal text that needs clear structure, reliable tone, formatting, and diagrams.

The English summary is being prepared. Showing the original description.

Bang-isme/CodexAI---Skills10Updated Oct 5, 2026

See all skills by Bang-isme

Report a problem with this skill