todo.md

This is a draft specification. It reflects how I've been handling my TODO lists for various small projects (too small to e.g. bother with a Trello board).

Example

A TODO file looks like this:

# TODO for `todo.md`

## Write about it on www.rollc.at

- [ ] 1 publish the post
- [ ] 4 write more TODO items here
- [ ] 5 spell check!
- [x] 2 include a nice example
    - [ ] 5 with more sections
    - [x] 1 with checkboxes
    - [x] 2 with priorities
    - [x] 5 with nested lists

## Create some tools

- [ ] 1 sorting
- [ ] 3 report / summary
    - [ ] 1 digest of currently pending items
    - [ ] 3 stats on complete / pending
    - [ ] 3 stats on relative priorities
    - [ ] 4 recurisve operation on a file tree
    - [ ] 5 integrate with git for burndown tracking
- [ ] 5 add-on library for common Md parsers
    - [ ] 1 Python
    - [ ] 4 Go
    - [ ] 5 Pandoc?

It is a single file, with plain, old Markdown, named todo.md.

Checklists

The file's contents consist of some free-form Markdown, which includes some checklists (possibly organised using # section markers).

Each item on a checklist includes three things:

Items are ticked off whenever completed.

Nested lists are allowed, to break down bigger tasks. Sub-items' importance is relative to parent's.

Sorting

Whenever the list undergoes some maintenance (tick off some items, add more, adjust priorities and descriptions, etc), it should be sorted afterwards.

Versioning and collaboration

Using a VCS is recommended. Git is suggested.

It is recommended that items are ticked off and lists sorted in the same unit of work (commit, pull request, revision, ...) that introduced the change.

Tooling

While the format is meant to be very human-friendly, some tooling can make working with it even easier.

Emacs

Future plans

More tools should be written. Once there is a repository, it will be linked here.

License

No.


See this as plaintext. Get the permalink. Check out related. Go home.