Add project-docs lifecycle meta-skill
This commit is contained in:
25
skills/project-docs/templates/gitea-readme.md.tpl
Normal file
25
skills/project-docs/templates/gitea-readme.md.tpl
Normal file
@@ -0,0 +1,25 @@
|
||||
# {{PROJECT_NAME}}
|
||||
|
||||
{{PROJECT_SHORT_DESCRIPTION}}
|
||||
|
||||
## 🛠 Demonstrated Skills & Tech Stack
|
||||
- **Core Technologies**: {{TECH_STACK}}
|
||||
- **Key Tools**: {{TOOLS_USED}}
|
||||
- **Engineering Capabilities**: {{DEMONSTRATED_SKILLS}}
|
||||
|
||||
## 🚀 Quick Start
|
||||
|
||||
```bash
|
||||
{{QUICK_START_COMMANDS}}
|
||||
```
|
||||
|
||||
## 📐 System Architecture
|
||||
|
||||
```mermaid
|
||||
{{MERMAID_DIAGRAM_SOURCE}}
|
||||
```
|
||||
|
||||
*Interactive Architecture Map available at:* [maps.lab.audasmedia.com.au/{{PROJECT_NAME}}](https://maps.lab.audasmedia.com.au/{{PROJECT_NAME}}/)
|
||||
|
||||
## 📝 Usage & Configuration
|
||||
{{USAGE_NOTES}}
|
||||
8
skills/project-docs/templates/mermaid-archify.mmd.tpl
Normal file
8
skills/project-docs/templates/mermaid-archify.mmd.tpl
Normal file
@@ -0,0 +1,8 @@
|
||||
flowchart LR
|
||||
U[User / Client] --> UI[Web Interface / Client App]
|
||||
UI --> API[API Gateway / Service Layer]
|
||||
API --> DB[(Database / Storage)]
|
||||
API --> AI[AI Agent Context / Engine]
|
||||
|
||||
click API "https://maps.lab.audasmedia.com.au/{{PROJECT_NAME}}/docs/" "View Archify Map"
|
||||
click DB "https://maps.lab.audasmedia.com.au/{{PROJECT_NAME}}/docs/" "View Archify Map"
|
||||
31
skills/project-docs/templates/obsidian-note.md.tpl
Normal file
31
skills/project-docs/templates/obsidian-note.md.tpl
Normal file
@@ -0,0 +1,31 @@
|
||||
---
|
||||
tags:
|
||||
- project
|
||||
- {{PROJECT_TAG}}
|
||||
- showcase
|
||||
skills:
|
||||
- {{DEMONSTRATED_SKILLS_LIST}}
|
||||
tools:
|
||||
- {{TOOLS_USED_LIST}}
|
||||
---
|
||||
|
||||
# {{PROJECT_NAME}} — Overview
|
||||
|
||||
## 💡 What is this project?
|
||||
{{HUMAN_EXPLANATION_SIMPLE}}
|
||||
|
||||
## 🌟 Key Highlights (Portfolio & Employment)
|
||||
- **Concept**: {{KEY_CONCEPT}}
|
||||
- **Tools & Skills Showcase**: {{SHOWCASE_HIGHLIGHTS}}
|
||||
- **Practical Value**: {{PRACTICAL_VALUE}}
|
||||
|
||||
## 📐 Architecture & Flow
|
||||
|
||||
```mermaid
|
||||
{{MERMAID_DIAGRAM_SOURCE}}
|
||||
```
|
||||
|
||||
## 🔗 Related Notes & Links
|
||||
- Gitea Repo: `{{GITEA_REPO_URL}}`
|
||||
- Interactive Map: [Archify Map](https://maps.lab.audasmedia.com.au/{{PROJECT_NAME}}/)
|
||||
- AI Context (Outline): `{{OUTLINE_DOC_URL}}`
|
||||
27
skills/project-docs/templates/outline-ai-context.md.tpl
Normal file
27
skills/project-docs/templates/outline-ai-context.md.tpl
Normal file
@@ -0,0 +1,27 @@
|
||||
# {{PROJECT_NAME}} — AI Agent Context & Context Recovery Guide
|
||||
|
||||
> **Target Audience**: AI Coding Agents & LLMs
|
||||
> **Purpose**: Deep context, environment variables, configuration directives, and restart runbooks for autonomous AI agents.
|
||||
|
||||
## 🎯 System Overview & Intent
|
||||
{{SYSTEM_INTENT_DETAILED}}
|
||||
|
||||
## ⚙️ Configuration & Environment
|
||||
- **Environment Variables**: {{ENV_VARIABLES}}
|
||||
- **Config Files**: {{CONFIG_PATHS}}
|
||||
- **Services & Ports**: {{SERVICES_AND_PORTS}}
|
||||
|
||||
## 📁 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}}`.
|
||||
|
||||
## ⚠️ Known Quirks & Recovery Runbooks
|
||||
{{KNOWN_QUIRKS_AND_RUNBOOKS}}
|
||||
22
skills/project-docs/templates/vikunja-tasks.json.tpl
Normal file
22
skills/project-docs/templates/vikunja-tasks.json.tpl
Normal file
@@ -0,0 +1,22 @@
|
||||
{
|
||||
"title": "{{PROJECT_NAME}} - Human Task Overview",
|
||||
"description": "High-level task checklist for human team members.",
|
||||
"tasks": [
|
||||
{
|
||||
"title": "Confirm Gitea repository creation & standard README",
|
||||
"done": false
|
||||
},
|
||||
{
|
||||
"title": "Review Obsidian portfolio note and employment skill highlights",
|
||||
"done": false
|
||||
},
|
||||
{
|
||||
"title": "Verify Mermaid architecture diagram & Archify map link",
|
||||
"done": false
|
||||
},
|
||||
{
|
||||
"title": "Ensure Outline AI context doc is present for agent restarts",
|
||||
"done": false
|
||||
}
|
||||
]
|
||||
}
|
||||
Reference in New Issue
Block a user