docs: add writing workbench operating skeleton

This commit is contained in:
wantsong 2026-06-02 16:25:23 +08:00
parent 756a0846a0
commit 26dd1a6e96
55 changed files with 716 additions and 2 deletions

View File

@ -51,3 +51,12 @@ In a new Codex session opened on this project, use:
Please read README.md, WORKBENCH.md, and docs/context-handoff.md first, then continue work on Writing Workbench according to those conventions. Please read README.md, WORKBENCH.md, and docs/context-handoff.md first, then continue work on Writing Workbench according to those conventions.
``` ```
## Operating A Project
Use `docs/operating-playbook.md` for the practical project workflow:
- when to start a project
- how to create a project folder
- which files must be filled first
- how to manage context packs, sessions, review rounds, and indexes
- how to keep CCPE System as the canonical asset source

View File

@ -38,6 +38,12 @@ Do not rename the project folder every time the article title changes. Store tit
Use `templates/article-project/PROJECT_STRUCTURE.md` as the expansion guide when creating a full project. Use `templates/article-project/PROJECT_STRUCTURE.md` as the expansion guide when creating a full project.
For a copyable starting point, use:
```text
templates/article-project/skeleton/
```
Top-level project files: Top-level project files:
- `project.md`: stable project identity, temporary title, final title when known, phase, status - `project.md`: stable project identity, temporary title, final title when known, phase, status
@ -126,4 +132,3 @@ When an article is completed:
- promote AI-facing model cards or runtime assets through `ccpe-system` only when mature enough - promote AI-facing model cards or runtime assets through `ccpe-system` only when mature enough
When a project is abandoned, move it to `projects/abandoned/` and preserve the reason in `status.md`. When a project is abandoned, move it to `projects/abandoned/` and preserve the reason in `status.md`.

View File

@ -0,0 +1 @@

View File

@ -0,0 +1 @@

View File

@ -0,0 +1 @@

206
docs/operating-playbook.md Normal file
View File

@ -0,0 +1,206 @@
# Writing Workbench Operating Playbook
This playbook explains how to run an article project inside Writing Workbench.
It is the operational layer between the workspace principles in `WORKBENCH.md` and the concrete project files under `projects/active/`.
## 1. When To Start A Project
Start a Writing Workbench project only after the user has decided that an idea should enter article production.
Do not use this workspace for:
- raw diary capture
- open-ended viewpoint exploration
- generic source archiving
- canonical CCPE asset creation
- video production planning
Those belong in Knowledge Vault, CCPE System, or the future Video Workbench.
## 2. Project ID
Use this folder pattern:
```text
projects/active/YYYY-MM-DD-aNNN-temp-slug/
```
Rules:
- `YYYY-MM-DD` is the project creation date.
- `aNNN` is a local article counter for that day.
- `temp-slug` is a stable working slug, not the final title.
- Do not rename the folder when the article title changes.
- Store title changes in `project.md`.
## 3. Creating A New Project
1. Copy the skeleton:
```powershell
Copy-Item -Recurse templates\article-project\skeleton projects\active\YYYY-MM-DD-aNNN-temp-slug
```
2. Fill these files first:
- `project.md`
- `source-map.md`
- `status.md`
- `00-creation-plan/creative-brief.md`
3. Update `indexes/active-projects.md`.
4. If CCPE assets are used, update:
- `indexes/ccpe-consumption-map.md`
- `ccpe-consumption/runtime-links.md` when a new reusable asset relationship is discovered
## 4. Minimum Viable Project State
A project is ready for article work when these files are no longer blank:
- `project.md`: identity, intent, target article type, decision gates
- `source-map.md`: source locations and source policy
- `status.md`: current phase, open decisions, next actions
- `00-creation-plan/context-pack.md`: the smallest useful pack for the first writer or reviewer
Do not dispatch writer or reviewer sessions before these files exist.
## 5. Phase Flow
Use this default sequence:
```text
00-creation-plan
01-positioning
02-outline
03-drafting
04-draft-review
05-appendix
06-metadata
07-tribunal
08-model-writing
publish
```
The user may skip optional stages, but record the decision in `status.md`.
Required before drafting:
- positioning is stable enough to write
- outline has passed review or the user has explicitly accepted the risk
- required sources are listed in `source-map.md`
- the active context pack is available
Required before publish:
- final article exists in `publish/final.md`
- unresolved review issues are either fixed or explicitly waived
- metadata is complete when needed
- archive destinations are recorded
## 6. Context Packs
Use the smallest pack that can support the task.
- `lite`: article goal, current artifact, core claims, constraints
- `standard`: lite pack plus source summaries and selected evidence
- `deep`: standard pack plus long excerpts, historical essays, or research material
Do not paste every source file into a context pack. Reference source paths unless selected excerpts are necessary.
## 7. Sessions And Reports
For each writer, reviewer, tribunal member, or modeling session, preserve both:
- `session.md`: process record
- `report.md`: final result or decision-ready output
The orchestrator should read reports, syntheses, and repair requests before reading full session records.
Use full sessions only when:
- the report is ambiguous
- a decision depends on reasoning history
- the user asks to inspect the process
- the next agent needs exact prior discussion details
## 8. Review Rounds
Each review round should preserve:
- `review-brief.md`
- one folder per reviewer
- each reviewer folder with `session.md` and `report.md`
- `synthesis.md`
- `repair-request.md`
The repair request should be addressed to the next writer or reviser. It should not be a generic list of review comments.
## 9. Index Synchronization
Update indexes as project state changes.
Use `indexes/active-projects.md` when:
- a project is created
- current phase changes
- next action changes
- lead writer or project status changes
Use `indexes/completed-projects.md` when:
- a project moves to `projects/completed/`
- final archive paths are known
- extracted model documents or CCPE improvement requests are known
Use `indexes/ccpe-consumption-map.md` when:
- a CCPE asset is used in a project
- an asset produces an output
- an issue or improvement request should be sent back to CCPE System
Use `indexes/extracted-models.md` when:
- the article produces a human-facing model document
- the model should be archived in Knowledge Vault
- the model has possible AI-facing Model Card potential
## 10. CCPE Boundary
Writing Workbench consumes CCPE assets. It does not redefine them.
Allowed here:
- canonical path references
- task-specific usage notes
- context packs for using an asset
- reports about asset issues
- improvement requests for CCPE System
Not allowed here:
- copied canonical Agent Specs
- copied canonical Model Cards
- copied canonical Skill definitions
- permanent forks of CCPE runtime protocols
Trial article runs should wait until the required CCPE agents or Lite prompts are available in CCPE System, unless the user explicitly chooses a manual placeholder workflow.
## 11. Completion And Archiving
When an article is complete:
1. Move the project folder from `projects/active/` to `projects/completed/`.
2. Keep all process records inside the completed project folder.
3. Archive the final essay to Knowledge Vault `sayings/`.
4. Archive human-facing model documents to Knowledge Vault `rules/`.
5. Promote AI-facing model assets only through CCPE System.
6. Update all relevant indexes.
When a project is abandoned:
1. Record the reason in `status.md`.
2. Move the project folder to `projects/abandoned/`.
3. Keep the process trail unless the user explicitly asks to remove it.

View File

@ -2,6 +2,20 @@
Use this structure when expanding a new active article project. Use this structure when expanding a new active article project.
The copyable project skeleton lives at:
```text
templates/article-project/skeleton/
```
Create a project with:
```powershell
Copy-Item -Recurse templates\article-project\skeleton projects\active\YYYY-MM-DD-aNNN-temp-slug
```
Then fill `project.md`, `source-map.md`, `status.md`, and `00-creation-plan/creative-brief.md` before dispatching writer or reviewer sessions.
```text ```text
YYYY-MM-DD-aNNN-temp-slug/ YYYY-MM-DD-aNNN-temp-slug/
project.md project.md
@ -79,4 +93,3 @@ YYYY-MM-DD-aNNN-temp-slug/
publish/ publish/
final.md final.md
``` ```

View File

@ -0,0 +1,23 @@
# Context Pack
## Pack Type
- lite
## Task
## Role Receiving This Pack
## Current Artifact
## Article Goal
## Core Claims
## Required Sources
## Selected Evidence
## Constraints
## Output Request

View File

@ -0,0 +1,19 @@
# Creative Brief
## Article Intention
## Reader
## Core Question
## Core Claim
## Desired Effect
## Must Include
## Must Avoid
## Initial Sources
## First Human Decision Needed

View File

@ -0,0 +1,11 @@
# Series Position
## Series
## Position In Series
## Previous Related Articles
## Next Possible Articles
## Continuity Requirements

View File

@ -0,0 +1,14 @@
# Writer Selection
## Candidate Writer Roles
## Selected Lead Writer
## Reason
## Style Constraints
## CCPE Asset Reference
- Canonical path:
- Local usage note:

View File

@ -0,0 +1,16 @@
# Positioning Final
## Final Premise
## Target Reader
## Main Claim
## Supporting Claims
## Article Boundary
## Approved By User
- Date:
- Notes:

View File

@ -0,0 +1,13 @@
# Premise
## Working Premise
## Reader Problem
## Article Promise
## Central Tension
## Boundary
## Open Questions

View File

@ -0,0 +1,9 @@
# Appendix Outline
## Appendix Purpose
## Candidate Sections
## Relationship To Main Article
## Open Questions

View File

@ -0,0 +1,16 @@
# Outline Final
## Final Title Candidate
## Opening
## Section Outline
## Closing
## Appendix Plan
## User Approval
- Date:
- Notes:

View File

@ -0,0 +1,13 @@
# Outline V1
## Title Candidate
## Opening
## Section Outline
## Closing
## Appendix Need
## Known Risks

View File

@ -0,0 +1,15 @@
# Outline V2
## Change Summary From V1
## Title Candidate
## Opening
## Section Outline
## Closing
## Appendix Need
## Remaining Risks

View File

@ -0,0 +1,15 @@
# Cognitive Imaging Report
## Verdict
## Strongest Parts
## Critical Issues
## Structural Risks
## Missing Context Or Evidence
## Repair Suggestions
## Questions For User

View File

@ -0,0 +1,3 @@
# Cognitive Imaging Session
## Process Record

View File

@ -0,0 +1,15 @@
# Giant Cognition Report
## Verdict
## Strongest Parts
## Critical Issues
## Structural Risks
## Missing Context Or Evidence
## Repair Suggestions
## Questions For User

View File

@ -0,0 +1,3 @@
# Giant Cognition Session
## Process Record

View File

@ -0,0 +1,13 @@
# Repair Request
## Addressed To
## Repair Goal
## Required Changes
## Constraints
## Evidence To Preserve
## Output Request

View File

@ -0,0 +1,16 @@
# Review Brief
## Review Target
## Reviewer Role
## Context Pack
## Review Objectives
## Known Concerns
## Required Output
- `session.md` for process record
- `report.md` for final review result

View File

@ -0,0 +1,11 @@
# Review Synthesis
## Shared Findings
## Conflicting Findings
## Highest Priority Repairs
## User Decisions Needed
## Recommendation

View File

@ -0,0 +1,15 @@
# Zhang Liao Report
## Verdict
## Strongest Parts
## Critical Issues
## Structural Risks
## Missing Context Or Evidence
## Repair Suggestions
## Questions For User

View File

@ -0,0 +1,3 @@
# Zhang Liao Session
## Process Record

View File

@ -0,0 +1,7 @@
# Full Draft
## Draft
## Known Gaps
## Writer Notes

View File

@ -0,0 +1,7 @@
# Full Revised Draft
## Revised Draft
## Change Notes
## Remaining Risks

View File

@ -0,0 +1,11 @@
# Revision Plan
## Review Inputs
## Required Revisions
## Optional Revisions
## User Decisions
## Revision Order

View File

@ -0,0 +1,5 @@
# Appendix Draft
## Draft
## Notes

View File

@ -0,0 +1,5 @@
# Appendix Final
## Final Appendix
## Archive Notes

View File

@ -0,0 +1,7 @@
# Image Prompt
## Prompt
## Constraints
## Negative Requirements

View File

@ -0,0 +1,7 @@
# Image URL
## Final Image URL
## Source
## License Or Usage Note

View File

@ -0,0 +1,13 @@
# Metadata Draft
## Title
## Subtitle
## Description
## Keywords
## Tags
## Categories

View File

@ -0,0 +1,17 @@
# Metadata Final
## Title
## Subtitle
## Description
## Keywords
## Tags
## Categories
## Image Prompt
## Image URL

View File

@ -0,0 +1,3 @@
# Metadata Session
## Process Record

View File

@ -0,0 +1,11 @@
# Tribunal
Use this stage only when the article needs multi-role judgment beyond normal review.
Do not run tribunal by default. Record the user decision in `status.md`.
## Inputs
## Roles
## Outputs

View File

@ -0,0 +1,12 @@
# Destination Map
## Human-Facing Archive
- Knowledge Vault path:
## AI-Facing Promotion Candidate
- CCPE System path:
- Promotion status:
## Index Updates

View File

@ -0,0 +1,14 @@
# Extraction Brief
## Source Article
## Candidate Human Model
## Extraction Goal
## Boundary
## Destination
- Knowledge Vault rules path:
- CCPE System potential:

View File

@ -0,0 +1,13 @@
# Model Draft
## Model Name
## Model Definition
## Core Structure
## Mechanism
## Applicable Scenarios
## Non-Applicable Scenarios

View File

@ -0,0 +1,21 @@
# Model Final
## Model Name
## Source Article
## Model Definition
## Core Structure
## Mechanism
## Applicable Scenarios
## Non-Applicable Scenarios
## Version Relationship
## Derivative Models
## AI Model Card Potential

View File

@ -0,0 +1,29 @@
# Project
## Identity
- Project ID:
- Temporary title:
- Final title:
- Status: active
- Current phase: 00-creation-plan
- Created:
- Last updated:
## Intent
## Target Article Type
## Lead Writer / Style
## Series Position
## Human Decision Gates
- Creation plan approval:
- Positioning approval:
- Outline approval:
- Draft repair approval:
- Publish approval:
## Notes

View File

@ -0,0 +1,9 @@
# Final Article
## Final Title
## Article
## Archive Destination
## Publication Notes

View File

@ -0,0 +1,15 @@
# Source Map
## Knowledge Vault Sources
## CCPE Sources
## External Sources
## Selected Materials
## Source Policy
This project references source files unless the user explicitly asks to copy selected excerpts into local context packs.
## Open Source Questions

View File

@ -0,0 +1,19 @@
# Status
## Current State
- Phase: 00-creation-plan
- Status: active
- Last updated:
## Completed
## Open Decisions
## Next Actions
## Blockers
## Phase Notes
Record skipped phases, waived review risks, archive destinations, and CCPE follow-up requests here.