Continue fixing refs
[worg.git] / org-tutorials / org-effectiveness.org
blob28d9891c44e1e90c16b4b766764dc2dab1befea8
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
44 $ git clone https://git.savannah.gnu.org/git/emacs/org-mode.git
45 #+END_SRC
47 You can find org-effectiveness.el in ~/git/org-mode/contrib/lisp
49 So, you can add the next line (or similar) in your .emacs
50 #+BEGIN_SRC lisp
51 (load "~/git/org-mode/contrib/lisp/org-effectiveness.el")
52 #+END_SRC
54 If you want use the plot feature, you must install gnuplot, for instance in debian, you can do:
55 #+BEGIN_SRC bash
56 $ apt-get install gnuplot
57 #+END_SRC
59 * Counting outlines
61 To measure the effectiveness we can count tasks done and tasks
62 cancelled, but perhaps you want count the tasks pending or tasks in
63 another state, so we've built some functions to it.
65 With org-effectiveness-count-keyword, we can count an outline in an
66 state (keyword) given. For example:
68 #+BEGIN_SRC lisp
69 M-x org-effectiveness-count-keyword TODO
70 #+END_SRC
72 Usually, anyone will be using the next states: TODO, CANCELED and DONE
73 at least, so we can use
75 #+BEGIN_SRC lisp
76 M-x org-effectiveness-count-todo
77 M-x org-effectiveness-count-done
78 M-x org-effectiveness-count-canceled
79 #+END_SRC
81 * Effectiveness
83 The calculus that I propose to know if someones is effectiveness is
84 very simple is enough dividing the number of tasks DONE with the
85 CANCELED. So, we can know the total effectiveness in the current
86 buffer with:
88 #+BEGIN_SRC lisp
89 M-x org-effectiveness
90 #+END_SRC
92 We can know, the effectiveness in a specific date with
94 #+BEGIN_SRC lisp
95 M-x org-effectiveness-in-date
96 #+END_SRC
98 Writing the date in the format YYYY-MM-DD.
101 * Productivity
103 Make an only task in one month is not very difficult, if you only want
104 make one task is ok, you are 100% effectiveness, but the people is
105 ambitious, the companies want reach many task, without cancel anything.
107 We can consider that measure our productivity is only measure the
108 tasks done in a period of time (see [[ref1][1]]). For example, in a month:
110 #+BEGIN_SRC lisp
111 M-x org-effectiveness-dones-in-date
112 #+END_SRC
114 * Deploying graphs
116 We can deploy a *gnuplot graph* to know the effectiveness in the current
117 buffer by months with:
119 #+BEGIN_SRC lisp
120 M-x org-effectiveness-plot
121 #+END_SRC
123 We can deploy an *ascii graph* to know the effectiveness in the current
124 buffer by months with:
126 #+BEGIN_SRC lisp
127 M-x org-effectiveness-plot-ascii
128 #+END_SRC
130 * References
132 1. <<ref1>> Barry W. Boehm, TRW (1987) Improving Software Productivity
135 * License
137 This document is under a [[http://creativecommons.org/licenses/by/3.0/deed][Creative Commons Attribution Unported 3.0]]
139 [[http://creativecommons.org/licenses/by/3.0/deed][file:http://i.creativecommons.org/l/by/3.0/80x15.png]]