Doc Metrics STC Conf 2011

8/2/2019 Doc Metrics STC Conf 2011

1/31

Developing Metrics to

Request Resources

Archana MaCitrix

Decem


2/31

About Metrics

Process of Defining Metrics

Benchmark Data

Project Summary

Sample Project Plan and Calculator

Agenda


3/31

About Metrics


4/31

To justify replacement requisitions after attrition

To justify additional headcount for special proje

To answer key questions from management

Why Metrics?

Where does your time go? Release x.x did not h

many key features? Why is the doc bug count still so high?

Why are we not collaborating with Customer Su

Why are the DITA and other special projects dela


5/31

What Metrics Do We Need?

Out of Scope forthis

presentation

ReliableRepeatable

Flexible Model

Quality MetricsProductivity Metrics


6/31

Activity 5 minutes

Attrition

Drivers forResourcePlanning


7/31

Drivers for Resource Planning

Hours per page or pages per hour(current)

Increase in number of new projects

Number of documentationrequirements from prospective

customers

Negative feedback and increasedsupport calls

Percent increase in engineeringheadcount

Increase in feature velocity

Attrition

ResourcePlanning


8/31

Factors Affecting Metrics

Activity 5 minutes


9/31


Teams Content Writers - Knowledge and experience

Editors - Knowledge and experience

SMEs - Knowledge and experience

SMEs - Uncooperative and unavailable

Complexity of content

Number & complexity of Illus

Type of source available

Number of pages modified


10/31


Product Other Product lifecycle

Number of UI elements

Tools and applications

PTO, holidays, events, and b


11/31



12/31


Define Metrics

Categorize Features &Bugs

Define Complexi

Define StandardProcesses

Define Hours per P

Identify Common Unitsof Work

Define StandardDeliverables


13/31

Identify Common Units of Work

Features Special Projec

Multimedia Projects

DITA

Usability

Collaboration with external te

Bugs

Release Notes


14/31

Identify Common Units of Work

Project-Related Tasks Non Project-Related A

PTO

Holidays

Training

Company Events

Project planning and management

Tools and templates

Peer Reviews

Release management activities

Working with doc and external teams


15/31

Define Standard Deliverables

PDFs / HTML Release Notes

Online Help Multimedia


16/31

Define Standard Processes

Research and Impact Analysis

Information and Delivery Design

Drafts

Production and Delive


17/31

Categorize Features and Bugs

Size of Features Duration

Small 1 2 days

Medium 3 5 days

Large 6 10 days

Extra Large 11+ days


18/31

Define Complexity

High

Average

Low

Complex concepts.

Interrelationships among topics make the content difficult to org No source available. SMEs very difficult and unresponsive. Need complete lab set up for testing.

Mostly basic procedures (GUI and CLI) with brief introductions. Information easily available.

Revised page. Not as highly complex as described above. Very little source material available.


19/31

Define Hours Per Page Writing Task

One average page is equal to approx. 300 words.

High

Average

Low

18 hours

9 hours

3 hours

14 hours

8 hours

2 hours

Complexity Junior Worker Senior Worker

10 hours (Average) 8 hours (Average)

Note


20/31

Define Hours Per Online Help Topic Writing

High

Average

Low

6 hours

3 hours

1 hour

4 hours

2 hours

1 hour

Complexity Junior Worker Senior Worker

Now online help is single sourced

New


21/31

Define Hours Editing Task

Activity Metric

First edit 25% of the writing time

Follow up edit discussions 10% of the writing time

Final edit sign-off 5% of the writing time


22/31

Benchmark Data

High-TechIndustries

PrintedDocumentation

7 to 8 hours a pageSource:Hackos (JoAnn T Hackos, 'Managing your documentation projectsJohn Wiley & Sons, 1994.)

3 to 5 hours a pageSource: Fredrickson Communications(www.fredcomm.com/articles/detail/stop_guesstimating_start_estimating/)

13 hours a pageSource: Jody Lorig's Estimating Worksheet(www.techwr-l.com/articles/estimatingworksheet)

Writing andEditing Tasks

OnlineDocumentation

4 to 6 hours a topicSource: Fredrickson Communications(www.fredcomm.com/articles/detail/stop_guesstimating_start_estimating/)
http://www.fredcomm.com/articles/detail/stop_guesstimating_start_estimating/http://www.techwr-l.com/articles/estimatingworksheet/http://www.fredcomm.com/articles/detail/stop_guesstimating_start_estimating/http://www.fredcomm.com/articles/detail/stop_guesstimating_start_estimating/http://www.techwr-l.com/articles/estimatingworksheet/http://www.fredcomm.com/articles/detail/stop_guesstimating_start_estimating/


23/31

Summary Release X and Y

# of Writers

# of Editors

# of Pages (new and updated)

5

1

756

Metric Release X

# of Hours (Writing and Editing)

# of Hours per Page (Writing andEditing)

6.58 hours

4985 hours

9.21 hours

# of Hours per Page (Writing Effort)

5

1

679

Release Y

5.05 hours

4803 hours

7.07 hours


24/31

Activity TimeLets extrapolate some d


25/31

Data Analysis 20 minutes

1. Why did Kathy have so many features?

2. How do you identify a low performer?

3. Why are there so many bugs in one writers name?

4. Why didn't one writer work on any special project?

5. Is there any writer who is close to his/her actual and ideal task distribution? Yes or No? Give rea

6. This release had very few features. True or false, and why?

7. Which writer had maximum features?

8. Creating Release Notes do not take up time.

9. How much time did writers spend on the special projects?

10. Writers are not spending 100% of their time on feature documentation? Is this good or bad? Exp


26/31

Switch to ExcelSpreadsheet to

View Actual

Metrics


27/31

Switch to ExcelSpreadsheet to

View an

Individual Plan


28/31

Chance to Win


29/31

Activity Time

1. Based on the given data, each team has to come up withnew logical interpretation of the data.

2. To support your interpretation, look at the individual planand let us know what additional metrics you need tocollect.

3. Bonus Question: Who is an outlier out of the fivewriters and why?

4. Each team will get 10 minutes to present their findings.

5. Each participant will vote for the best team.

6. One team will be announced as the winner.


30/31

Presentations by the Team10 minutes each


31/31

Questions

Citrix Confidential

Documents

Doc Metrics STC Conf 2011