Guide Creator for Openclaw

Guide Creator is a specialized documentation system that generates and maintains standardized project guides to ensure seamless AI context recovery and development continuity.

revolgmphl
v1.0.0
Mar 1, 2026
1
898
0

Install & Download

1. ClawHub CLI

The fastest way to install a skill directly from the registry.

npx clawhub@latest install guide-creator

2. Manual Installation

Copy the skill folder to one of these locations

Global
~/.openclaw/skills/
Workspace
<project>/skills/

Priority: Workspace > Local > Bundled

3. Prompt Installation

Copy this prompt to OpenClaw to install it automatically.

Help me install guide-creator using Clawhub. If Clawhub is not installed, install it first (npm i -g clawhub).

Prefer to download?

Get the raw skill files in a ZIP archive.

What is Guide Creator?

Guide Creator is an essential utility designed to solve the problem of lost context in long-term AI-assisted development. By implementing a standardized documentation architecture consisting of a start.md file and a dedicated guide/ directory, it creates a persistent memory for your project. This tool is a cornerstone for developers using Openclaw Skills who want to maintain a professional, technical source of truth that covers design philosophy, technical architecture, and versioned update logs.

The skill operates in three distinct phases: initialization, active updating, and context recovery. Whether you are building games, web applications, or CLI tools, Guide Creator ensures that every code change is documented and every hard-earned lesson is recorded in a way that AI agents can easily parse and respect in future sessions.

Guide Creator Use Cases

  • Initializing a standardized documentation skeleton for new software projects.
  • Automating the generation of changelogs and version increments during feature development.
  • Documenting technical pitfalls and lessons learned to prevent recurring bugs.
  • Facilitating rapid context recovery for AI agents in new chat sessions.
  • Creating structured architectural overviews for complex systems using Mermaid diagrams.

How Guide Creator Works

  1. The user initializes the project documentation using a specialized script to generate a standard folder hierarchy and template files.
  2. Key project metadata, startup commands, and file manifests are populated in the start.md file for immediate agent orientation.
  3. During the development lifecycle, the user triggers update commands to append new changelog entries and record pitfalls.
  4. The system synchronizes version numbers and file references across the guide/ directory to maintain data integrity.
  5. When starting a new session, the AI agent follows a hierarchical reading strategy—from quick-start info to version history—to fully reconstruct the project context.

Guide Creator Setup

To begin using this skill for your project, follow these installation steps:

  1. Ensure Python 3.x is installed on your system.
  2. Run the initialization script to create your documentation framework:
python3 scripts/init_guide.py --project-name "Your Project Name" --type general --root /path/to/project
  1. Define your project type (game, web, cli, lib, or general) to receive optimized templates.
  2. Complete the metadata in start.md and guide/guide.md to provide the baseline context for Openclaw Skills.

Guide Creator Data Schema & Taxonomy

The skill organizes project intelligence into a strict file hierarchy:

File/Folder Description Criticality
start.md Startup instructions, service addresses, and file manifest. Required
guide/guide.md Main index, technical stack, and architecture overview. Required
guide/01-design.md Core design philosophy and project positioning. Required
guide/06-tech.md Technical architecture and folder structure details. Required
guide/08-changelog.md Versioned history (vX.Y) with sub-system grouping. Required
guide/09-pitfalls.md Record of problems, root causes, and solutions. Required
guide/02-05 Domain-specific docs (e.g., API routes, NPC systems). Optional

Guide Creator Advanced Features

  • Multi-mode operational support for Init, Update, and Recovery workflows.
  • Domain-optimized templates for Game, Web, and CLI development.
  • Automatic version incrementing and cross-file metadata synchronization.
  • Intelligent archiving logic that moves large changelogs to a dedicated archive directory.
  • Standardized pitfall tracking with a high-priority General Development Principles section to enforce agent constraints.
  • Tiered context recovery strategies (Fast, Full, Targeted, or Review) based on the specific developer task.

SKILL.md


Loading

Related Openclaw Skills

METADATA

Github Stars: 0
forks: 0

Featured*