A structured Obsidian vault workflow for creating, classifying, validating, linking, updating, and archiving engineering documentation.
Install & Download
1. ClawHub CLI
The fastest way to install a skill directly from the registry.
npx clawhub@latest install obsidian-doc-workflow
2. Manual Installation
Copy the skill folder to one of these locations
~/.openclaw/skills/ <project>/skills/ Priority: Workspace > Local > Bundled
3. Prompt Installation
Copy this prompt to OpenClaw to install it automatically.
Help me install obsidian-doc-workflow 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 Obsidian Documentation Workflow?
The Obsidian Documentation Workflow is an Openclaw Skills capability for maintaining consistent, searchable, and connected documentation inside an Obsidian vault. It separates project-specific information from reusable engineering knowledge, applies canonical templates, and enforces predictable folder, filename, frontmatter, tagging, and linking conventions.
It supports the full document lifecycle, from selecting the correct location and creating a document to validating metadata and internal links, then safely moving obsolete content into Deprecated, Superseded, or Historical archives. This makes Openclaw Skills useful for engineering teams that need reliable documentation without deleting technical history or creating empty, inconsistent pages.
Obsidian Documentation Workflow Use Cases
- Create project documentation beginning with a
Project Overview.mdand expanding into architecture, development, testing, deployment, API, and maintenance documents. - Capture reusable engineering patterns, technology guides, security practices, and deployment strategies in
02 Shared Knowledge/. - Classify information as project-specific, shared knowledge, or external resource before creating a file.
- Apply consistent YAML frontmatter, lowercase kebab-case tags, status values, dates, areas, and project relationships.
- Build an Obsidian knowledge graph with standard Wikilinks, cross-folder links, and deep links to section headings.
- Validate new or updated documents for required metadata, filename and title alignment, working links, code-language declarations, and current update dates.
- Archive obsolete, replaced, or historical material without deleting the original content.
- Translate or summarize Persian source material into primarily English documentation while preserving the vault's language convention.
How Obsidian Documentation Workflow Works
- Resolve the vault path from
OBSIDIAN_VAULT_PATH, using the documented Mac default when the variable is not set. - Determine whether the content belongs in
01 Projects/{Project}/,02 Shared Knowledge/, or03 Resources/based on its scope and future reuse. - Select the canonical template from
00 Meta/Templates/, such asProject Overview.md,Architecture.md,Guide.md,Concept.md,Tool.md,Runbook.md, orResource.md. - Create the document with the required frontmatter, preserving the property order of
type,status, optionalproject,area,created,updated,tags, and additional fields. - Write content according to the selected template, ensuring the filename matches the document title and avoiding empty pages or style-only rewrites of technical material.
- Add relevant internal Wikilinks, cross-folder links, deep section links, and related-document references to strengthen the knowledge graph.
- Apply no more than five lowercase kebab-case tags, including appropriate domain, document-type, status, technology, and project classifications.
- Validate the finished document for complete frontmatter, resolvable links, descriptive external-link text, language-specific code fences, accurate dates, and required domain and type tags.
- When content becomes obsolete, move it to the correct archive destination, update its status to
archivedordeprecated, and link the replacement or superseding document.
Obsidian Documentation Workflow Setup
- Set the vault location if it is not stored at the documented default path.
export OBSIDIAN_VAULT_PATH="/path/to/your/obsidian-vault"
- Ensure the vault contains the primary sections
00 Meta/,01 Projects/,02 Shared Knowledge/,03 Resources/, and04 Archives/. - Keep the canonical templates in
00 Meta/Templates/, including project, architecture, guide, API reference, testing, deployment, ADR, decision, research, concept, tool, runbook, maintenance, and resource templates. - For a project, create its directory under
01 Projects/{Project}/and begin withProject Overview.md. - For reusable knowledge, use the appropriate
Concept.mdorTool.mdtemplate under02 Shared Knowledge/. - Populate required YAML frontmatter with current dates, a valid status, an appropriate area, relevant tags, and project relationships where applicable.
- No package installation or external service is required; the workflow operates on the configured Obsidian vault and its Markdown files.
Obsidian Documentation Workflow Data Schema & Taxonomy
Vault organization
| Location | Purpose |
|---|---|
00 Meta/ |
Vault standards, templates, and guidance |
01 Projects/{Project}/ |
Project-specific documentation |
02 Shared Knowledge/ |
Reusable engineering patterns and technical knowledge |
03 Resources/ |
External references |
04 Archives/Deprecated/ |
Obsolete technologies, patterns, or tools |
04 Archives/Superseded/ |
Documents replaced by newer or consolidated documentation |
04 Archives/Historical/ |
Completed reviews, old decisions, and historical snapshots |
Project document structure
A typical project contains Project Overview.md, Architecture & Tech Stack.md, Development Guide.md, Component & API Reference.md, Testing Guide.md, Deployment & Infrastructure.md, Maintenance Board.md, Changelog.md, and additional architecture, service, database, or guide documents as needed.
Frontmatter fields
type: Project, architecture, guide, reference, research, runbook, maintenance, changelog, concept, or tool classification.status:active,archived, ordeprecated;draftmay be used in tagging conventions.project: Project name for project-scoped documents.area: Such asfrontend,backend,infra,security,testing,devops, orpatterns.createdandupdated: ISO-style document dates.tags: Up to five lowercase kebab-case tags covering technology, domain, type, status, and project context.related_projects: Related project names for shared or cross-project knowledge.
Linking and file rules
Use [[Document Name]] for internal links, [[Folder/Document Name]] for cross-folder links, and [[Document Name#Section Heading]] for deep links. Titles must match filenames without the .md extension, and documents should remain primarily in English.
Obsidian Documentation Workflow Advanced Features
- Scope-aware classification distinguishes project implementations from reusable knowledge and external references.
- Canonical template enforcement keeps document structures consistent across projects and shared knowledge.
- Metadata taxonomy supports document type, lifecycle status, technical area, technology, and project tags.
- Knowledge-graph linking supports standard Wikilinks, cross-folder references, bidirectional relationships, and heading-level deep links.
- Lifecycle validation checks frontmatter completeness, filename-title alignment, broken Wikilinks, external-link descriptions, code-block languages, dates, and required tags.
- Safe archival preserves technical history and separates deprecated, superseded, and historical material.
- Guardrails prevent destructive deletion, empty placeholder documents, noncanonical template structures, and unnecessary rewrites of technical content.
- Multi-language handling keeps documentation primarily in English while translating or summarizing Persian source material.
- The workflow is filesystem-oriented and lightweight, requiring no package installation or external API integration.
SKILL.md
Loading
Related Openclaw Skills
StratPit
StratPit lets AI agents play one-on-one strategy games for USDC prizes, with code-enforced rules and automated payouts.
Douyin Competitor Radar
Analyze public Douyin content, creator activity, hot trends, and comments to uncover competitor insights and practical marketing opportunities.
Kuaishou Competitor Radar
Collect and compare public Kuaishou video, creator, and comment data to support competitor research and content strategy.
SignalLayer x402 Preflight
Check unfamiliar x402 payment terms and Base recipients before an authorized wallet interaction—without treating findings as a safety guarantee.
Engineering & Architecture Memory
Guide AI coding agents to make code changes that preserve architectural integrity, minimize complexity, and are verified with evidence.
Sandbox Implementation SOP (SOP-DEV-001)
A mandatory agent workflow for implementing and validating changes in a clean sandbox before anything is executed on the host.
Featured*
