← 返回
未分类

vibe-coding-live-docs

Use when starting a new project or large feature, or when project docs have drifted, and Codex needs to scaffold, update, or repair living documents such as PRD, architecture, page frame, tech decisions, and project state without freezing technical details too early.
aEboli
未分类 community v1.0.0 1 版本 99107.1 Key: 无需
★ 0
Stars
📥 111
下载
💾 0
安装
1
版本
#latest

概述

Vibe Coding Live Docs

Overview

Keep project docs alive from the first sketch to the shipped system. This skill turns PRD, architecture, page structure, decisions, and state tracking into living artifacts that move through Draft, Confirmed, and As-Built instead of becoming abandoned setup docs.

Quick Start

  • Create project-docs/PRD.md, project-docs/ARCHITECTURE.md, and project-docs/PROJECT_STATE.md as Draft skeletons at project start.
  • If the PRD input is a feature idea, rough brief, meeting notes, stakeholder ask, or research summary, use RECOMMENDED SUB-SKILL: $prd-creater first to draft a structured PRD, then map it into project-docs/PRD.md.
  • For UI or multi-page work, also create project-docs/PAGE_FRAME.md.
  • For non-trivial stack choices, also create project-docs/TECH_DECISIONS.md.
  • Use project-docs/PROJECT_STATE.md as the document-sync control tower: track doc debt, latest confirmations, next refill node, and frozen decisions.
  • If a mature PRD already exists, the task is small, or the user does not want a Notion-style PRD, skip $prd-creater and maintain the docs directly.
  • Update docs on milestones and key events instead of waiting until release.

Lifecycle

  • Draft
  • Use for hypotheses, placeholders, candidate stack choices, page sketches, and open questions.
  • Confirmed
  • Use after the first runnable version or when major decisions are stable enough to guide implementation.
  • As-Built
  • Use before release or handoff to record what actually shipped, what changed, and what risk remains.

Trigger Matrix

Update the right docs when these triggers happen:

  • Milestones
  • Project start
  • First runnable version
  • Core flow stable
  • Release prep
  • Events
  • Stack locked
  • Page frame locked
  • Module boundary changed
  • Auth or data flow changed
  • Third-party dependency chosen or replaced

Document Contract

  • project-docs/PRD.md
  • Product intent, user journeys, acceptance, page summary
  • project-docs/ARCHITECTURE.md
  • Current architecture, modules, data flow, auth, and as-built structure
  • project-docs/PROJECT_STATE.md
  • Current slice, document debt, next update node, frozen decisions
  • project-docs/PAGE_FRAME.md
  • Page inventory, navigation, key states, transitions
  • project-docs/TECH_DECISIONS.md
  • Chosen options, rejected options, constraints, decision dates

Workflow

  1. Detect whether the task is a new project, a large feature, or a drifting documentation cleanup.
  2. If the PRD starts from rough source material, use RECOMMENDED SUB-SKILL: $prd-creater to draft the first-pass PRD.
  3. Create or repair the minimum living-doc skeleton first.
  4. Put uncertain information in Draft instead of pretending it is final.
  5. Promote sections to Confirmed when real implementation or decisions stabilize them.
  6. Promote key docs to As-Built before release, handoff, or major milestone closeout.
  7. Keep decision history in project-docs/TECH_DECISIONS.md and UI structure in project-docs/PAGE_FRAME.md so project-docs/PRD.md and project-docs/ARCHITECTURE.md stay readable.

PRD Drafting Boundary

  • Use $prd-creater when the input is messy and the main need is turning it into a structured first-pass PRD.
  • Use vibe-coding-live-docs to place that PRD in project-docs/PRD.md, add lifecycle metadata, and keep it aligned with architecture, page frame, and project state.
  • Do not force $prd-creater when:
  • a mature PRD already exists
  • the task only needs a small status update
  • the user does not want a Notion-style PRD flow

Resources

Read only what you need:

  • references/living-docs-playbook.md
  • Full doctrine, lifecycle, and document ownership model
  • references/update-matrix.md
  • What to update at each milestone and event
  • assets/templates/
  • Starter templates for all core docs and appendices

Common Mistakes

  • Writing every detail too early and never revisiting it
  • Leaving page or stack decisions only in chat history
  • Updating only PROJECT_STATE.md when architecture or page structure changes
  • Treating Draft as shameful instead of intentional
  • Waiting until release to reconstruct docs from memory

版本历史

共 1 个版本

  • v1.0.0 Initial release 当前
    2026-04-07 00:59 安全 安全

安全检测

腾讯云安全 (Keen)

安全,无风险
查看报告

腾讯云安全 (Sanbu)

安全,无风险
查看报告

🔗 相关推荐

ai-intelligence

ontology

oswalpalash
类型化知识图谱,用于结构化智能体记忆与可组合技能。支持创建/查询实体(人员、项目、任务、事件、文档)及关联...
★ 713 📥 243,958
security-compliance

Skill Vetter

spclaudehome
AI智能体技能安全预审工具。安装ClawdHub、GitHub等来源技能前,检查风险信号、权限范围及可疑模式。
★ 1,216 📥 266,630
ai-intelligence

Self-Improving + Proactive Agent

ivangdavila
自我反思+自我批评+自我学习+自组织记忆。智能体评估自身工作、发现错误并持续改进。
★ 1,360 📥 318,618