Missing Doc

Create Missing Documentation Guide

Follow this guide to create documentation where it is missing following Marty conventions.

When to Create Docs

• Feature has no documentation
• API endpoint not documented
• Process not documented
• Configuration not explained
• Runbook missing for operations
• Onboarding docs need updating

Documentation Locations

Creation Process

Step 1: Identify Missing Documentation

# Check what exists
find docs -type f -name "*.md"

# Identify gaps
# Compare existing to what should exist

# Check for API coverage
grep -r "api" docs/ --include="*.md"

Step 2: Research Content

• Understand the feature/process
• Identify target audience
• Gather requirements
• Collect examples

Step 3: Create Documentation

# Create appropriate file
cat > docs/path/new-doc.md << 'EOF'
# Title

## Summary
Brief description of what this covers.

## Details
Detailed information...

## Examples
Code examples if applicable...

## Related
Links to related documentation.
EOF

Documentation Structure

---
title: Document Title
description: Brief description
last_updated: YYYY-MM-DD
---

# Title

## Overview
What is this about?

## Prerequisites
What is needed before?

## Guide
Step-by-step content...

## Examples
Working examples...

## Troubleshooting
Common issues and solutions...

## Related
Links to related docs.

Checklist for New Docs

• Clear title
• Purpose stated
• Audience identified
• Prerequisites listed
• Steps are clear
• Examples work
• Linked to related docs

Quick Reference

Check existing:       find docs -type f -name "*.md"
Create API doc:       cat > docs/api/endpoint.md << 'EOF' ...
Create guide:         cat > docs/guides/topic.md << 'EOF' ...
Add to index:         Update docs/README.md if exists

Related Skills