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.

Safety Notice

This listing is from the official public ClawHub registry. Review SKILL.md and referenced scripts before running.

Copy this and send it to your AI assistant to learn

Install skill "ogt-docs" with this command: npx skills add EduardoU24/ogt-docs

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

Source Transparency

This detail page is rendered from real SKILL.md content. Trust labels are metadata-based hints, not a safety guarantee.

Related Skills

Related by shared tags or category signals.

Web3

Model Tester

Test agents or models against predefined test cases to validate model routing, performance, and output quality. Use when: (1) verifying a specific agent or m...

Registry SourceRecently Updated
Web3

Make Git Escrow

Create a new git escrow bounty for a test suite. Use when the user wants to submit a challenge with escrowed token rewards for passing a failing test suite....

Registry SourceRecently Updated
Web3

Fulfill Git Escrow

Fulfill a git escrow bounty by writing a solution or submitting an existing one. Use when the user wants to solve a test suite challenge, write code to pass...

Registry SourceRecently Updated
ogt-docs | V50.AI