← 返回
开发者工具 中文

OGT Docs

Documentation-as-Source-of-Truth workflow. Use when working with projects that use docs/ as the canonical source for definitions, rules, and tasks. Routes to specialized sub-skills for specific documentation types.
文档即真相源工作流。适用于将 docs/ 作为定义、规则与任务唯一来源的项目。针对特定文档类型路由至专门的子技能。
eduardou24
开发者工具 clawhub v1.0.0 1 版本 99828.8 Key: 无需
★ 0
Stars
📥 1,166
下载
💾 9
安装
1
版本
#latest

概述

OGT Docs - Documentation as Source of Truth

Philosophy

Documentation is the database of decisions. Code is merely its implementation.

┌─────────────────────────────────────────────────────────────────┐
│                    THE DOC-FIRST PRINCIPLE                      │
├─────────────────────────────────────────────────────────────────┤
│  1. Documentation DEFINES what something IS                     │
│  2. Code IMPLEMENTS what documentation specifies                │
│  3. Conflicts RESOLVE in favor of documentation                 │
│                                                                 │
│  If docs say X and code does Y → CODE IS WRONG                  │
└─────────────────────────────────────────────────────────────────┘

When to Use This Skill

Use ogt-docs when you need to:

  • Understand the docs/ folder structure
  • Find the right sub-skill for a specific task
  • Initialize a new docs-first project
  • Navigate between definition types

For specific tasks, use the specialized sub-skills listed below.

Documentation Structure Overview

docs/
├── definitions/              # WHAT things ARE
│   ├── business/             # Business model, pricing, users
│   ├── features/             # Product features and specs
│   ├── technical/            # Architecture, services, data
│   └── domain/               # Domain-specific concepts
│
├── rules/                    # HOW to IMPLEMENT
│   ├── code/                 # Coding standards
│   │   ├── frontend/
│   │   ├── backend/
│   │   └── infra/
│   ├── git/                  # Version control rules
│   └── domain/               # Domain-specific rules
│
├── todo/                     # TASK management
│   ├── pending/              # Not started
│   ├── in_progress/          # Being worked on
│   ├── review/               # Awaiting review
│   ├── blocked/              # Cannot proceed
│   ├── done/                 # Completed & verified
│   └── rejected/             # Declined tasks
│
├── guides/                   # HOW-TO documents
│   └── {topic}/
│
└── social/                   # Marketing & communications
    ├── campaigns/
    ├── content/
    └── branding/

The Folder-as-Entity Pattern

Every documentable item is a folder containing:

{item_slug}/
├── {type}.md                 # Primary document (task.md, feature.md, etc.)
├── {supporting_files}.md     # Additional documentation
└── .{signal_files}           # Status markers and metadata

Benefits:

  • Move entire folder between workflow stages
  • Attach unlimited supporting files
  • Signal status via dot-files
  • Version and track changes atomically

Sub-Skills Reference

Definitions (WHAT things ARE)

Sub-SkillPurposeUse When
------------------------------------------------------------------------------------------
ogt-docs-defineGeneral definition guidanceNeed overview of definition types
ogt-docs-define-businessBusiness model, pricing, usersDefining business concepts
ogt-docs-define-featureProduct features and specsSpecifying a new feature
ogt-docs-define-codeTechnical architectureDefining services, data models
ogt-docs-define-marketingBrand, messaging, audienceMarketing definitions
ogt-docs-define-brandingVisual identity, toneBrand guidelines
ogt-docs-define-toolsTooling and CLI specsDefining developer tools

Rules (HOW to IMPLEMENT)

Sub-SkillPurposeUse When
-------------------------------------------------------------------------------
ogt-docs-rulesGeneral rules guidanceNeed overview of rule types
ogt-docs-rules-codeCoding standards overviewGeneral code rules
ogt-docs-rules-code-frontFrontend-specific rulesReact, CSS, components
ogt-docs-rules-code-backBackend-specific rulesAPI, database, services
ogt-docs-rules-code-infraInfrastructure rulesDocker, CI/CD, deployment
ogt-docs-rules-gitVersion control rulesCommits, branches, PRs

Tasks (WHAT to DO)

Sub-SkillPurposeUse When
---------------------------------------------------------------------------
ogt-docs-create-taskCreate and manage tasksNeed to create/update a task
ogt-docs-audit-taskVerify task completionChecking if task is truly done

Other

Sub-SkillPurposeUse When
----------------------------------------------------------------------------------
ogt-docs-createGeneral creation guidanceNeed to create any doc type
ogt-docs-create-socialMarketing contentCreating social/marketing content
ogt-docs-auditGeneral audit guidanceAuditing documentation
ogt-docs-initInitialize docs structureSetting up new project
ogt-docs-configConfiguration optionsCustomizing docs workflow

Workflow Overview

flowchart TB
    subgraph define ["1. DEFINE"]
        D1[Create Definition]
        D2[Get Approval]
    end

    subgraph regulate ["2. REGULATE"]
        R1[Create Rules]
        R2[Add Examples]
    end

    subgraph implement ["3. IMPLEMENT"]
        I1[Create Task]
        I2[Write Code]
        I3[Review]
    end

    subgraph verify ["4. VERIFY"]
        V1[Run Checks]
        V2[Confirm Match]
    end

    define --> regulate --> implement --> verify
    verify -->|Mismatch| implement
    verify -->|Docs Wrong| define

Quick Start

"I need to define something new"

→ Use ogt-docs-define to understand types, then the specific sub-skill

"I need to create a task"

→ Use ogt-docs-create-task

"I need to check if a task is really done"

→ Use ogt-docs-audit-task

"I need to add coding rules"

→ Use ogt-docs-rules-code or the specific frontend/backend/infra variant

"I need to set up docs for a new project"

→ Use ogt-docs-init

Naming Conventions

ElementFormatExample
----------------------------------------------------------------------------
Folder slugssnake_caseglobal_search, user_auth
Primary fileslowercase typetask.md, feature.md, rule.md
Supporting fileslowercase descriptivephase_0.md, notes.md, progress.md
Signal filesdot + snake_case.blocked_reason, .approved_by_human

Signal Files Reference

Signal files are dot-files that indicate status or metadata.

SignalTypeMeaning
--------------------------------------------------------
.versionContentSchema/doc version (JSON)
.blockedEmptyItem is blocked
.blocked_reasonContentWhy it's blocked
.approvedEmptyApproved for implementation
.approved_by_{name}EmptyWho approved
.rejectedEmptyRejected
.rejected_reasonContentWhy rejected
.verifiedEmptyImplementation verified
.completed_atContentCompletion timestamp
.assigned_to_{agent}EmptyWho's working on it
.pr_linkContentAssociated PR URL
.depends_onContentDependencies list

The Golden Rules

  1. If it's not documented, it doesn't exist
  2. If code contradicts docs, code is wrong
  3. Never trust "done" status without verification
  4. Move folders, don't copy files
  5. Signal with dot-files, don't edit status fields

版本历史

共 1 个版本

  • v1.0.0 当前
    2026-03-29 01:10 安全 安全

安全检测

腾讯云安全 (Keen)

安全,无风险
查看报告

腾讯云安全 (Sanbu)

安全,无风险
查看报告

🔗 相关推荐

developer-tools

Github

steipete
使用 `gh` CLI 与 GitHub 交互,通过 `gh issue`、`gh pr`、`gh run` 和 `gh api` 管理议题、PR、CI 运行及高级查询。
★ 671 📥 324,378
developer-tools

Gog

steipete
Google Workspace 命令行工具,支持 Gmail、日历、云端硬盘、通讯录、表格和文档。
★ 921 📥 185,826
developer-tools

CodeConductor.ai

larsonreever
AI驱动平台,提供快速全栈开发、智能体、工作流自动化及低代码AI集成的可扩展产品创建。
★ 68 📥 180,347