todo-application.md - www.codemadness.org - www.codemadness.org saait content files
 (HTM) git clone git://git.codemadness.org/www.codemadness.org
 (DIR) Log
 (DIR) Files
 (DIR) Refs
 (DIR) README
 (DIR) LICENSE
       ---
       todo-application.md (2544B)
       ---
            1 This article describes a TODO application or workflow.
            2 
            3 
            4 ## Workflow
            5 
            6 It works like this:
            7 
            8 * Open any text editor.
            9 * Edit the text.
           10 * Save it in a file (probably named "TODO").
           11 * Feel happy about it.
           12 
           13 
           14 ## The text format
           15 
           16 The text format I use is this:
           17 
           18         [indendations]<symbol><SPACE><item text><NEWLINE>
           19 
           20 Most of the time an item is just one line.
           21 This format is just a general guideline to keep the items somewhat structured.
           22 
           23 
           24 ## Symbols
           25 
           26 Items are prefixed with a symbol.
           27 
           28 * - is an item which is planned to be done at some point.
           29 * x is an item which is done.
           30 * ? is an item which I'm not (yet) sure about. It can also be an idea.
           31 
           32 I use an indendation with a TAB before an item to indicate item dependencies.
           33 The items can be nested.
           34 
           35 For the prioritization I put the most important items and sections from the top
           36 to the bottom. These can be reshuffled as you wish of course.
           37 
           38 To delete an item you remove the line. To archive an item you keep the line.
           39 
           40 
           41 ## Sections
           42 
           43 A section is a line which has no symbol. This is like a header to group items.
           44 
           45 
           46 ## Example
           47 
           48         Checklist for releasing project 0.1:
           49         - Test project with different compilers and check for warnings.
           50         - Documentation:
           51                 - Proofread and make sure it matches all program behaviour.
           52                 - Run mandoc -Tlint on the man pages.
           53                 ? Copy useful examples from the README file to the man page?
           54         - Run testsuite and check for failures before release.
           55         
           56         
           57         project 0.2:
           58         ? Investigate if feature mentioned by some user is worth adding.
           59 
           60 
           61 # Example: secure remote cloud-encrypted edit session(tm)
           62 
           63         ssh -t host 'ed TODO'
           64 
           65 # Example: multi-user secure remote cloud-encrypted edit session(tm)
           66 
           67         ssh host
           68         tmux or tmux a
           69         ed TODO
           70 
           71 # Example: version-controlled multi-user secure remote cloud-encrypted edit session(tm)
           72 
           73         ssh host
           74         tmux or tmux a
           75         ed TODO
           76         git add TODO
           77         git commit -m 'TODO: update'
           78 
           79 ## Pros
           80 
           81 * When you open the TODO file the most important items are at the top.
           82 * The items are easy to read and modify with any text editor.
           83 * It is easy to extend the format and use with other text tools.
           84 * The format is portable: it works on sticky-notes on your CRT monitor too!
           85 * No monthly online subscription needed and full NO-money-back guarantee.
           86 
           87 
           88 ## Cons
           89 
           90 * Complex lists with interconnected dependencies might not work, maybe.
           91 * It's assumed there is one person maintaining the TODO file. Merging items
           92   from multiple people at the same time in this workflow is not recommended.
           93 * It is too simple: noone will be impressed by it.
           94 
           95 
           96 I hope this is inspirational or something,