Skip to content

README.md

Latest commit

 

History

History
115 lines (80 loc) · 2.82 KB

README.md

File metadata and controls

115 lines (80 loc) · 2.82 KB
Raw

Feature Documentation

📖 Overview

Documentation for all major features in DocuNote.

Each feature is documented with:

  • Why it exists (design decisions)
  • How it's implemented (technical details)
  • What it does (quick summary)

🗂️ Documentation Structure

For each feature, create a subfolder with these files:

docs/03-features/your-feature/
├── suggestions.md       # Design options explored
├── implementation.md    # Technical implementation
└── summary.md          # Quick reference

📚 Example: Theme Toggle Feature

See theme-toggle/ for a complete example:

This demonstrates: ✅ Thorough design exploration
✅ Clear technical documentation
✅ Quick reference for future developers
✅ Testing strategy included

🎯 Current Features

1. Theme Toggle

Location: theme-toggle/
Status: ✅ Complete and tested
Description: Quick light/dark theme toggle with keyboard shortcut (Ctrl+Shift+T)

Key Files:

  • Component: src/components/theme-toggle-button.tsx
  • Tests: e2e/ui-features.spec.ts (theme tests)

✍️ How to Document a New Feature

Step 1: Create Feature Folder

mkdir docs/03-features/my-feature

Step 2: Create Documentation Files

Create three files:

  • suggestions.md - Design exploration and options
  • implementation.md - Technical implementation details
  • summary.md - Quick reference

Step 3: Update This README

Add your feature to the "Current Features" section above.

Step 4: Update Main README

If it's a major feature, add it to docs/README.md

📋 Documentation Checklist

When documenting a feature:

  • Created feature subfolder in 03-features/
  • Created suggestions.md with design options
  • Created implementation.md with technical details
  • Created summary.md with quick overview
  • Updated this README with feature listing
  • Included code examples where helpful
  • Documented testing approach
  • Added screenshots (if UI feature)

🎨 Documentation Best Practices

  1. Write for future developers

    • Explain your thought process
    • Document why decisions were made
    • Include lessons learned

  2. Keep it up to date

    • Update docs when features change
    • Mark deprecated features

  3. Use examples

    • Code snippets
    • Screenshots
    • Command examples

  4. Link related resources

    • Related features
    • External documentation

Need inspiration? Look at the theme-toggle example for comprehensive feature documentation.