Update project-docs skill with Outline document catalog index & ste-writing integration
This commit is contained in:
@@ -1,27 +1,30 @@
|
||||
# {{PROJECT_NAME}} — AI Agent Context & Context Recovery Guide
|
||||
# {{PROJECT_NAME}} — AI Document Index & Context
|
||||
|
||||
> **Target Audience**: AI Coding Agents & LLMs
|
||||
> **Purpose**: Deep context, environment variables, configuration directives, and restart runbooks for autonomous AI agents.
|
||||
> **Target**: AI Agents
|
||||
> **Writing Style**: ASD-STE100 Simplified Technical English (`ste-writing`). Brief, terse, active voice.
|
||||
|
||||
## 🎯 System Overview & Intent
|
||||
{{SYSTEM_INTENT_DETAILED}}
|
||||
## 📚 Document Catalog (Inject Specific Document)
|
||||
Read this index to inject the exact file you need. Do not search all files.
|
||||
|
||||
## ⚙️ Configuration & Environment
|
||||
- **Environment Variables**: {{ENV_VARIABLES}}
|
||||
- **Config Files**: {{CONFIG_PATHS}}
|
||||
- **Services & Ports**: {{SERVICES_AND_PORTS}}
|
||||
| Document Title | Path | Scope / Description |
|
||||
| :--- | :--- | :--- |
|
||||
| **System Overview** | `docs/outline/01-system-overview.md` | Explains project purpose, main architecture, and active services. |
|
||||
| **Configuration & Env** | `docs/outline/02-config-and-env.md` | Lists environment variables, config paths, network ports, and secrets. |
|
||||
| **Code Structure Map** | `docs/outline/03-code-map.md` | Shows folder structure, core entry points, and primary dependencies. |
|
||||
| **AI Agent Runbook** | `docs/outline/04-agent-runbook.md` | Gives step-by-step commands to build, test, and restart agent work. |
|
||||
|
||||
## 📁 Key File Map
|
||||
```
|
||||
{{DIRECTORY_TREE_SUMMARY}}
|
||||
```
|
||||
---
|
||||
|
||||
## 🔄 AI Agent Resume Protocol
|
||||
When restarting or resuming work on this project, an AI agent MUST:
|
||||
1. Verify system dependencies and services are running.
|
||||
2. Read `docs/outline-ai-context.md` (this file) for structural understanding.
|
||||
3. Check Git status and recent commits (`git log -n 5`).
|
||||
4. Execute validation tests: `{{VALIDATION_COMMANDS}}`.
|
||||
## 🎯 System Summary
|
||||
{{SYSTEM_INTENT_STE_TERSE}}
|
||||
|
||||
## ⚠️ Known Quirks & Recovery Runbooks
|
||||
{{KNOWN_QUIRKS_AND_RUNBOOKS}}
|
||||
## ⚙️ Core Configuration
|
||||
- **Env File**: `{{ENV_FILE_PATH}}`
|
||||
- **Config Directory**: `{{CONFIG_DIR_PATH}}`
|
||||
- **Active Ports**: `{{ACTIVE_PORTS}}`
|
||||
|
||||
## 🔄 Agent Restart Steps
|
||||
1. Read the Document Catalog above. Inject only required files.
|
||||
2. Check git status: `git status`.
|
||||
3. Check recent commits: `git log -n 5 --oneline`.
|
||||
4. Run validation test: `{{VALIDATION_COMMAND}}`.
|
||||
|
||||
Reference in New Issue
Block a user