ArchDoc Documentation

Task Lists

Create interactive checklists in your documents

Task Lists

Task lists let you create interactive checklists directly in your documents.

Creating a Task List

Using the Toolbar

  1. Place your cursor where you want the list
  2. Click the Task List (☑️) button in the toolbar
  3. Type your first task
  4. Press Enter to add more tasks

Using Keyboard Shortcut

  • Windows/Linux: Ctrl + Shift + 9
  • Mac: Cmd + Shift + 9

Using Markdown

- [ ] Unchecked task
- [x] Completed task
- [ ] Another task

Checking and Unchecking

Click the checkbox to toggle task completion:

  • Not started
  • Completed

Tasks can be checked/unchecked in both edit and view modes.

Nested Task Lists

Create hierarchical task lists by indenting:

  • Main task
    • Subtask 1
    • Subtask 2 (completed)
    • Subtask 3
  • Another main task
    • Its subtask

To nest:

  1. Press Tab to indent
  2. Press Shift + Tab to outdent

Use Cases

Project Planning

  • Define requirements
    • Gather stakeholder input
    • Document use cases
    • Prioritize features
  • Technical design
    • Write design doc
    • Review with team
  • Implementation
    • Phase 1 development
    • Testing
    • Deployment

Code Review Checklist

  • Code follows style guide
  • Unit tests added
  • Documentation updated
  • No security vulnerabilities
  • Performance considered
  • Error handling in place

ADR Decision Checklist

  • Context documented
  • Options evaluated
  • Decision stated clearly
  • Consequences listed
  • Reviewed by architect

RFC Review Checklist

  • Summary is clear
  • Motivation explained
  • Alternatives considered
  • Implementation plan included
  • Risks identified
  • Sign-offs requested

Launch Checklist

  • All tests passing
  • Documentation complete
  • Monitoring configured
  • Alerts set up
  • Rollback plan ready
  • Stakeholders notified
  • Go/no-go decision made

Best Practices

Keep Lists Focused

  • Group related tasks together
  • Use separate lists for different categories
  • Don't make lists too long

Use Clear Task Descriptions

Good:

  • Update API documentation for /users endpoint
  • Add error handling for authentication failures

Avoid:

  • Fix it
  • Do the thing

Track Progress

  • Check off tasks as you complete them
  • Leaves a record of what's done
  • Shows progress to collaborators

Combine with Text

Add context around your checklists:

Before Launch

Ensure all items are completed before deploying:

  • Code review approved
  • QA testing passed
  • Load testing completed
  • Security review done

Keyboard Shortcuts

ActionShortcut
Create task listCtrl/Cmd + Shift + 9
New task (in list)Enter
Indent taskTab
Outdent taskShift + Tab
Toggle checkboxClick or Enter on checkbox

Mixing List Types

You can use task lists alongside other list types:

Requirements (numbered for order)

  1. User must be able to login
  2. Dashboard shows recent documents
  3. Documents support sign-offs

Implementation Tasks (checkable)

  • Build login form
  • Create dashboard API
  • Add sign-off workflow

Notes (bullets)

  • Consider mobile layout
  • Follow existing design patterns
  • Check accessibility

Task Lists in Workflows

During Document Creation

Use task lists to track your writing progress:

  • Write overview section
  • Add technical details
  • Include diagrams
  • Proofread
  • Request reviews

During Review

Reviewers can use task lists for feedback:

  • Address performance concerns
  • Clarify deployment strategy
  • Add error handling section

After Acceptance

Track implementation against the document:

  • Implement core feature
  • Add tests
  • Update monitoring
  • Deploy to production

On this page