add installation.
[worg.git] / org-tutorials / org-effectiveness.org
1 #+OPTIONS:    H:3 num:nil toc:t \n:nil ::t |:t ^:t -:t f:t *:t tex:t d:(HIDE) tags:not-in-toc
2 #+STARTUP:    align fold nodlcheck hidestars oddeven lognotestate
3 #+SEQ_TODO:   TODO(t) INPROGRESS(i) WAITING(w@) | DONE(d) CANCELED(c@)
4 #+TAGS:       Write(w) Update(u) Fix(f) Check(c)
5 #+TITLE: Org Effectiveness Tutorial
6 #+AUTHOR: David Arroyo Menéndez 
7 #+EMAIL: davidam@es.gnu.org 
8 #+LANGUAGE:   en
9 #+PRIORITIES: A C B
10 #+CATEGORY:   worg-tutorial
11
12 # This file is the default header for new Org files in Worg.  Feel free
13 # to tailor it to your needs.
14 #+STARTUP:    align fold nodlcheck hidestars indent
15
16 [[file:index.org][{Back to Worg's index}]]
17
18 * Introduction
19
20 In the Personal Software Process, we attend to the tasks in the
21 estimated time, but few times we attend to effectiveness,
22 understanding by effectiveness, the tasks done comparising the
23 proposed tasks.
24
25 The formal educative process try evaluate with respect to solve exams,
26 that is, quizes or another academic tests and some times training
27 exercises, although, few times the student knows if execute your own
28 personal objectives: what is the reason because I've started to study
29 something if I've learn it or don't. Finally, someone knows if learn
30 things because has been able to make. The idea presented in this
31 tutorial is a software to everyone can be evaluted to himself in
32 function to his own personal objectives.
33
34 * Installation
35 Currently, org-effectiveness.el is stored in worg, you can download worg with:
36 #+BEGIN_SRC bash
37 $ git clone git://orgmode.org/worg.git
38 #+END_SRC
39 You can find org-effectiveness.el in ~/git/worg/code/elisp
40
41 * Counting outlines
42
43 To measure the effectiveness we can count tasks done and tasks
44 cancelled, but perhaps you want count the tasks pending or tasks in
45 another state, so we've built some functions to it.
46
47 With org-effectiveness-count-keyword, we can count an outline in an
48 state (keyword) given. For example:
49
50 #+BEGIN_SRC lisp
51 M-x org-effectiveness-count-keyword TODO
52 #+END_SRC
53
54 Usually, anyone will be using the next states: TODO, CANCELED and DONE
55 at least, so we can use
56
57 #+BEGIN_SRC lisp
58 M-x org-effectiveness-count-todo
59 M-x org-effectiveness-count-done
60 M-x org-effectiveness-count-canceled
61 #+END_SRC
62
63 * Effectiveness
64
65 The calculus that I propose to know if someones is effectiveness is
66 very simple is enough dividing the number of tasks DONE with the
67 CANCELED. So, we can know the total effectiveness in the current
68 buffer with:
69
70 #+BEGIN_SRC lisp
71 M-x org-effectiveness
72 #+END_SRC
73
74 We can know, the effectiveness in a specific date with 
75
76 #+BEGIN_SRC lisp
77 M-x org-effectiveness-in-date
78 #+END_SRC
79
80 Writing the date in the format YYYY-MM-DD.
81
82 * Deploying graphs
83
84 We can deploy a gnuplot graph to know the effectiveness in the curren
85 buffer by months with:
86
87 #+BEGIN_SRC lisp
88 M-x org-effectiveness-plot
89 #+END_SRC
90
91 * License
92
93 This document is under a [[http://creativecommons.org/licenses/by/3.0/deed][Creative Commons Attribution Unported 3.0]]
94
95 [[http://creativecommons.org/licenses/by/3.0/deed][file:http://i.creativecommons.org/l/by/3.0/80x15.png]]