skills.rest
gleeb
gleebCOMMUNITY
Explore all skills by this author →
GitHub

project-documentation

Standardize staging documentation workflows and integrate verified content into permanent docs.

Updated Aug 23, 2026
Search Tags:#documentation#traceability#sdlc#quality standards#agent-ready#staging journals#docs integration
One-click install
npx skills add https://github.com/gleeb/ai-registry --skill project-documentation-gleeb
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: project-documentation
Source: https://github.com/gleeb/ai-registry/tree/main/systems/sdlc/skills/project-documentation
Command: npx skills add https://github.com/gleeb/ai-registry --skill project-documentation-gleeb

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Prevents documentation drift by standardizing how implementation-time staging documentation is created and then integrated into permanent, AI-consumable project docs.

Core Features & Use Cases

  • AI-first docs structure: Defines how the docs/ folder functions as a technical reference for agents (not a project board), and where staging work lives.
  • Staging workflow template: Guides architects and implementers to scaffold story staging docs under docs/staging/ with plan traceability, acceptance criteria, and tech stack context.
  • Integration checklist for permanent docs: Provides a repeatable process to merge decisions, issues/resolutions, lessons learned, and file references from staging into domain docs and update docs/index.md when needed.

Quick Start

Use the project-documentation skill to scaffold a new implementation staging journal at docs/staging/US-NNN-story-name.md from the staging-doc template, then later integrate its content into the permanent docs using the integration checklist.

Frequently Asked Questions about project-documentation

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I prevent documentation drift during the software development lifecycle?▼

Prevent documentation drift by standardizing how implementation-time staging documentation is created and then integrated into permanent, AI-consumable project docs using a structured staging and integration workflow.

What is the best way to make project documentation AI-ready for agents?▼

Make project documentation AI-ready by structuring the docs/ folder as a technical reference for agents, ensuring consistent semantics, plan-to-doc traceability, and checklist-driven integration of decisions and troubleshooting.

How do I create staging documents for user stories?▼

Create staging documents for user stories by scaffolding implementation journals under docs/staging/ using a template that includes plan traceability, acceptance criteria, and tech stack context.

How do I integrate staging journals into permanent docs references?▼

Integrate staging journals into permanent docs by applying a checklist-driven process to merge decisions, issues, lessons learned, and file references into domain docs, then update docs/index.md.

Does this documentation workflow require specific dependencies?▼

No specific dependencies are required. The workflow relies on standard markdown file structures within the docs/ folder, utilizing staging journals and an integration checklist to maintain technical references.

When should I use a staging workflow for project documentation?▼

Use a staging workflow for project documentation when creating implementation-time journals for user stories, updating templates during implementation, and promoting verified content into permanent references.

Related Skills

Explore More Software Engineering Skills→
timzaaktimzaak
64

t-design

Generate technical designs with API interfaces, data models, and integration points.

Community
Advanced
tneztnez

process-sessions

Converts session notes into searchable digital text via OCR technology.

Community
Basic
fullstackrayfullstackray

update-docs

Update changelogs, functionality docs, tech docs, and archived plans after feature releases.

Community
Intermediate
HaipingXuHaipingXu
21

replication-package

Automate preparation of publication-ready replication packages for academic journals.

Community
Advanced