Subversion Repositories DevTools

Rev

Go to most recent revision | Details | Last modification | View Log | RSS feed

Rev Author Line No. Line
1293 dpurdie 1 
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN""http://www.w3.org/TR/html4/loose.dtd">
2 
<HTML
3 
><HEAD
4 
><TITLE
5 
>Topic Information</TITLE
6 
><META
7 
NAME="GENERATOR"
8 
CONTENT="Modular DocBook HTML Stylesheet Version 1.79"><LINK
9 
REL="HOME"
10 
TITLE="The Codestriker Guide"
11 
HREF="book1.html"><LINK
12 
REL="UP"
13 
TITLE="User's Guide"
14 
HREF="c333.html"><LINK
15 
REL="PREVIOUS"
16 
TITLE="Topic Properties"
17 
HREF="x624.html"><LINK
18 
REL="NEXT"
19 
TITLE="Topic Search"
20 
HREF="x656.html"></HEAD
21 
><BODY
22 
CLASS="SECT1"
23 
BGCOLOR="#FFFFFF"
24 
TEXT="#000000"
25 
LINK="#0000FF"
26 
VLINK="#840084"
27 
ALINK="#0000FF"
28 
><DIV
29 
CLASS="NAVHEADER"
30 
><TABLE
31 
SUMMARY="Header navigation table"
32 
WIDTH="100%"
33 
BORDER="0"
34 
CELLPADDING="0"
35 
CELLSPACING="0"
36 
><TR
37 
><TH
38 
COLSPAN="3"
39 
ALIGN="center"
40 
>The Codestriker Guide: Version 1.9.3</TH
41 
></TR
42 
><TR
43 
><TD
44 
WIDTH="10%"
45 
ALIGN="left"
46 
VALIGN="bottom"
47 
><A
48 
HREF="x624.html"
49 
ACCESSKEY="P"
50 
>Prev</A
51 
></TD
52 
><TD
53 
WIDTH="80%"
54 
ALIGN="center"
55 
VALIGN="bottom"
56 
>Chapter 3. User's Guide</TD
57 
><TD
58 
WIDTH="10%"
59 
ALIGN="right"
60 
VALIGN="bottom"
61 
><A
62 
HREF="x656.html"
63 
ACCESSKEY="N"
64 
>Next</A
65 
></TD
66 
></TR
67 
></TABLE
68 
><HR
69 
ALIGN="LEFT"
70 
WIDTH="100%"></DIV
71 
><DIV
72 
CLASS="SECT1"
73 
><H1
74 
CLASS="SECT1"
75 
><A
76 
NAME="TOPIC-INFORMATION"
77 
>3.8. Topic Information</A
78 
></H1
79 
><P
80 
>        From the "View Topic" page (see <A
81 
HREF="x504.html#VIEW-TOPIC"
82 
>Section 3.5.1</A
83 
>),
84 
        the "Topic Information" tab can be clicked to view and edit
85 
        topic information.  An example screenshot of this page
86 
	    can be seen in <A
87 
HREF="x637.html#FIGURE-TOPIC-INFORMATION"
88 
>Figure 3-12</A
89 
>.
90 
        <DIV
91 
CLASS="FIGURE"
92 
><A
93 
NAME="FIGURE-TOPIC-INFORMATION"
94 
></A
95 
><P
96 
><B
97 
>Figure 3-12. Topic Properties Screenshot</B
98 
></P
99 
><DIV
100 
CLASS="MEDIAOBJECT"
101 
><P
102 
><IMG
103 
SRC="topicinformation.png"></P
104 
></DIV
105 
></DIV
106 
>
107 
      </P
108 
><P
109 
>            This page is divided into four sections.  The "Comment
110 
            Metrics" section provides an aggregate count for the
111 
            number of comment threads with specific comment metric
112 
            values.  The "Total" subsection displays the number of
113 
            comment threads in the topic, followed by the total number
114 
            of comments submitted.  This is followed by the "Topic
115 
            Metrics" and "User Metrics" sections for this topic.  If
116 
            there are additional metrics defined here via the
117 
            Codestriker configuration file, the user will be able to
118 
            update their values here.  The last part of the page is
119 
            the "Activity Log", which provides an audit trail of all
120 
            the important events that occurred in the topic's
121 
            lifetime, such as creation and state changes.
122 
      </P
123 
><P
124 
>         The Codestriker time metric is calculated by keeping
125 
	 timestamps of every refresh from the http server for the
126 
	 given topic. Now, just because you are not refreshing the
127 
	 topic does not mean that you are not looking at the topic.
128 
	 Codestriker will assume that you are looking at the topic for
129 
	 4 minutes after the last refresh. If you click on a topic,
130 
	 and close the browser, it is logged as 4 minutes. The
131 
	 situation is unavoidable unless you put a camera on the
132 
	 computer and keep track of how long people are sitting at
133 
	 their computer, awake, and looking at the browser window. If
134 
	 this is not acceptable, users of Codestriker have the option
135 
	 to ask the reviewers to directly log the time spent in the
136 
	 review. The direct logging can be enabled via
137 
	 <CODE
138 
CLASS="VARNAME"
139 
>$metrics_config</CODE
140 
> variable in the
141 
	 <TT
142 
CLASS="FILENAME"
143 
>codestriker.conf</TT
144 
> file. The Codestriker time
145 
	 metric is "free" metric, being that it does not require any
146 
	 extra interactions with the user to operate. The trade off is
147 
	 that the accuracy of the data may not be as good as the
148 
	 direct logging done by a disciplined team. However, if your
149 
	 team is not very disciplined and can't be trusted to put in
150 
	 100% accurate data, the Codestriker time metric will be
151 
	 better because it will not be biased by the reviewer's
152 
	 logging discipline.
153 
      </P
154 
><P
155 
>        The code that deals with all of the this is in
156 
	<TT
157 
CLASS="FILENAME"
158 
>lib/Codestriker/Model/Metrics.pm</TT
159 
>, in
160 
        the <TT
161 
CLASS="FILENAME"
162 
>calculate_topic_view_time</TT
163 
> method.
164 
      </P
165 
></DIV
166 
><DIV
167 
CLASS="NAVFOOTER"
168 
><HR
169 
ALIGN="LEFT"
170 
WIDTH="100%"><TABLE
171 
SUMMARY="Footer navigation table"
172 
WIDTH="100%"
173 
BORDER="0"
174 
CELLPADDING="0"
175 
CELLSPACING="0"
176 
><TR
177 
><TD
178 
WIDTH="33%"
179 
ALIGN="left"
180 
VALIGN="top"
181 
><A
182 
HREF="x624.html"
183 
ACCESSKEY="P"
184 
>Prev</A
185 
></TD
186 
><TD
187 
WIDTH="34%"
188 
ALIGN="center"
189 
VALIGN="top"
190 
><A
191 
HREF="book1.html"
192 
ACCESSKEY="H"
193 
>Home</A
194 
></TD
195 
><TD
196 
WIDTH="33%"
197 
ALIGN="right"
198 
VALIGN="top"
199 
><A
200 
HREF="x656.html"
201 
ACCESSKEY="N"
202 
>Next</A
203 
></TD
204 
></TR
205 
><TR
206 
><TD
207 
WIDTH="33%"
208 
ALIGN="left"
209 
VALIGN="top"
210 
>Topic Properties</TD
211 
><TD
212 
WIDTH="34%"
213 
ALIGN="center"
214 
VALIGN="top"
215 
><A
216 
HREF="c333.html"
217 
ACCESSKEY="U"
218 
>Up</A
219 
></TD
220 
><TD
221 
WIDTH="33%"
222 
ALIGN="right"
223 
VALIGN="top"
224 
>Topic Search</TD
225 
></TR
226 
></TABLE
227 
></DIV
228 
></BODY
229 
></HTML
230 
>