sdd-steering

Generate and sync Markdown steering documents from codebase analysis.

Updated Dec 2, 2025

Search Tags:#project management #documentation #knowledge management #codebase analysis #sync #steering

Ready to run

npx skills add https://github.com/qlawmarq/dotfiles-common --skill sdd-steering-qlawmarq

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: sdd-steering
Source: https://github.com/qlawmarq/dotfiles-common/tree/main/skills/sdd-init/references/skills/steering
Command: npx skills add https://github.com/qlawmarq/dotfiles-common --skill sdd-steering-qlawmarq

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill automates the management of persistent project knowledge within the docs/steering/ directory, ensuring it remains synchronized with the codebase and captures essential project patterns.

Core Features & Use Cases

Bootstrap Steering: Generates initial steering documents (product, tech, structure) from codebase analysis when the directory is empty or incomplete.
Sync Steering: Keeps existing steering documents aligned with code changes by detecting drift and proposing additive updates.
Preserve Customizations: Ensures user-added content within steering files is protected during updates.
Use Case: When starting a new project, use this Skill to automatically generate foundational steering documents based on the initial codebase structure and technologies. Later, use it to ensure that new features or architectural changes are reflected in the steering documentation without overwriting manual annotations.

Quick Start

Use the sdd-steering skill to bootstrap the steering documentation for this project.

Frequently Asked Questions about sdd-steering

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

FAQPage Schema

How do I automatically generate project documentation from codebase analysis?▼

You can automatically generate project documentation by analyzing the codebase to extract product, technical, and structural patterns, then outputting the results as Markdown files in the docs/steering/ directory during project initialization.

What is the best way to keep documentation synchronized with code changes?▼

Keeping documentation synchronized involves detecting drift between the codebase and existing files, then proposing additive updates to the Markdown knowledge files to align them with new features or architectural changes.

How do I update steering documents without overwriting manual annotations?▼

To update steering documents without overwriting manual annotations, the sync process specifically preserves user-added content and customizations, ensuring only generated sections receive additive updates.

What do I need to bootstrap steering files for a new project?▼

Bootstrapping steering files requires an existing codebase to analyze, file search tools to locate relevant code, and pattern extraction capabilities to generate the initial product, technical, and structural Markdown documentation.

When should I use codebase analysis for project knowledge management?▼

You should use codebase analysis for project knowledge management during project initialization to create foundational documents, and during ongoing maintenance to ensure documentation captures evolving structural patterns.