Use https://git.savannah.gnu.org/cgit/emacs/org-mode.git for links
[worg.git] / org-tutorials / org-effectiveness.org
blob9b35e8d27cf86419d2c644cbfbedac02687b163a
1 #+TITLE: Org Effectiveness Tutorial
2 #+AUTHOR: David Arroyo Menéndez
3 #+EMAIL: davidam@es.gnu.org
4 #+OPTIONS:    H:3 num:nil toc:t \n:nil ::t |:t ^:t -:t f:t *:t tex:t d:(HIDE) tags:not-in-toc
5 #+STARTUP:    align fold nodlcheck hidestars oddeven lognotestate
6 #+SEQ_TODO:   TODO(t) INPROGRESS(i) WAITING(w@) | DONE(d) CANCELED(c@)
7 #+TAGS:       Write(w) Update(u) Fix(f) Check(c)
8 #+LANGUAGE:   en
9 #+PRIORITIES: A C B
10 #+STARTUP:    align fold nodlcheck hidestars indent
11 #+CATEGORY:   worg-tutorial
13 # This file is released by its authors and contributors under the GNU
14 # Free Documentation license v1.3 or later, code examples are released
15 # under the GNU General Public License v3 or later.
17 [[file:index.org][{Back to Worg's index}]]
19 * Introduction
21 In the Personal Software Process, we attend to the tasks in the
22 estimated time, but few times we attend to effectiveness,
23 understanding by effectiveness, the tasks done comparising the
24 proposed tasks.
26 The formal educative process try evaluate with respect to solve exams,
27 that is, quizes or another academic tests and some times training
28 exercises, although, few times the student knows if execute your own
29 personal objectives: what is the reason because I've started to study
30 something if I've learn it or don't. Finally, someone knows if learn
31 things because has been able to make. The idea presented in this
32 tutorial is a software to everyone can be evaluted to himself in
33 function to his own personal objectives. We can say that measure the
34 effectiveness is know if we are honest whith ourselves.
36 * Installation
38 Currently, org-effectiveness.el is stored in contrib, you can download worg with:
39 #+BEGIN_SRC bash
40 $ cd ~
41 $ mkdir git
42 $ cd git
43 $ git clone https://code.orgmode.org/bzg/org-mode.git
44 #+END_SRC
46 You can find org-effectiveness.el in ~/git/org-mode/contrib/lisp
48 So, you can add the next line (or similar) in your .emacs
49 #+BEGIN_SRC lisp
50 (load "~/git/org-mode/contrib/lisp/org-effectiveness.el")
51 #+END_SRC
53 If you want use the plot feature, you must install gnuplot, for instance in debian, you can do:
54 #+BEGIN_SRC bash
55 $ apt-get install gnuplot
56 #+END_SRC
58 * Counting outlines
60 To measure the effectiveness we can count tasks done and tasks
61 cancelled, but perhaps you want count the tasks pending or tasks in
62 another state, so we've built some functions to it.
64 With org-effectiveness-count-keyword, we can count an outline in an
65 state (keyword) given. For example:
67 #+BEGIN_SRC lisp
68 M-x org-effectiveness-count-keyword TODO
69 #+END_SRC
71 Usually, anyone will be using the next states: TODO, CANCELED and DONE
72 at least, so we can use
74 #+BEGIN_SRC lisp
75 M-x org-effectiveness-count-todo
76 M-x org-effectiveness-count-done
77 M-x org-effectiveness-count-canceled
78 #+END_SRC
80 * Effectiveness
82 The calculus that I propose to know if someones is effectiveness is
83 very simple is enough dividing the number of tasks DONE with the
84 CANCELED. So, we can know the total effectiveness in the current
85 buffer with:
87 #+BEGIN_SRC lisp
88 M-x org-effectiveness
89 #+END_SRC
91 We can know, the effectiveness in a specific date with
93 #+BEGIN_SRC lisp
94 M-x org-effectiveness-in-date
95 #+END_SRC
97 Writing the date in the format YYYY-MM-DD.
100 * Productivity
102 Make an only task in one month is not very difficult, if you only want
103 make one task is ok, you are 100% effectiveness, but the people is
104 ambitious, the companies want reach many task, without cancel anything.
106 We can consider that measure our productivity is only measure the
107 tasks done in a period of time (see [[ref1][1]]). For example, in a month:
109 #+BEGIN_SRC lisp
110 M-x org-effectiveness-dones-in-date
111 #+END_SRC
113 * Deploying graphs
115 We can deploy a *gnuplot graph* to know the effectiveness in the current
116 buffer by months with:
118 #+BEGIN_SRC lisp
119 M-x org-effectiveness-plot
120 #+END_SRC
122 We can deploy an *ascii graph* to know the effectiveness in the current
123 buffer by months with:
125 #+BEGIN_SRC lisp
126 M-x org-effectiveness-plot-ascii
127 #+END_SRC
129 * References
131 1. <<ref1>> Barry W. Boehm, TRW (1987) Improving Software Productivity
134 * License
136 This document is under a [[http://creativecommons.org/licenses/by/3.0/deed][Creative Commons Attribution Unported 3.0]]
138 [[http://creativecommons.org/licenses/by/3.0/deed][file:http://i.creativecommons.org/l/by/3.0/80x15.png]]