You are on page 1of 10

Documentation Plan

Documentation Plan
Mover, LLC.

Page 1

Documentation Plan

Documentation Overview

Project Scope and Objectives


The scope of our project is to develop an accessible user interface for the Mover
application. This user interface will allow the user to order shipments or moves in
a simple and affordable way.

Documentation Scope and Objectives

Develop User Interface


User friendly design
Consistent Design elements thru the app
In depth Interviews
Make Mover available in App Store and Google Play

Outline of Deliverables
Deliverable

Purpose

Audience

Development
of User
Interface

The purpose of this is to


make a seamless, easy
to use platform for people
to make moves of small
items.,

All users of the


software:

All users

FAQs

Provide general
knowledge and answers
to consumers.
Troubleshoot common
problems
create a simple app
walkthru that would show
the user how to make a
move.

all users

Intro App
walkthru

Output
Media

Writer/
Owner

app

SME

Reviewers
Mover employees

Taylor

app

Prospective Users

Mover employees
Brandon

app

mover employees

prospective users

Page 2

Detailed Content Plan


[Provide a detailed analysis of the elements of each deliverable as listed in the
Outline of Deliverables. Describe the goals of the deliverable, how it will be
organized, rationale for approach, and high-level content points. This section
supports development of team resource plans and timelines].

Deliverable 1: User Interface


[Include the following information for each deliverable.]
Goals and Objectives
The goal of this objective is to create a simple, easy to use platform that allows for
the client to make a seamless move in the most cost effective and efficient way.
Using creative design elements and communication strategies in our user-facing
application.
Audience
The main audience for this user-facing application would be the initial app user. This
user will most likely be in their 20s-30s and own a smartphone. They will most likely
live within 30 miles of a large metropolitan area, and they either don't have access
to a large vehicle or don't have a vehicle at all.
Approach
Since the app concept is relatively new to the market ease of use will be a key
focus in the development. The user will most likely be tech savvy so that works into
our favor.

Initial Outline

Work Breakdown and Expected Review Cycle


[List the planned number of draft cycles and what will be included in each cycle.
Identify SME reviewers based on the type of content included (e.g. developers,
business analysts, product manager, help desk manager, etc.]

1) Content plan
a) Content plan creation
b) Content plan review and update
2) Draft 1 Wireframing
a) Written by Taylor
b) Reviewed by Jackson and Brandon
3) Interviewing
a) Written by Jackson
b) Administered by Jackson
c) Reviewed by Taylor and Brandon
4) Beta Testing
a) Administered by Taylor, Jackson, and Brandon
b) Files sent to testers by Brandon
5) Revisions Made
a) Revised by Jackson
b) Reviewed by Taylor and Brandon
c) Cleanup
d) Release to production

Timeline and Milestones


Assumptions
[Delineate any assumptions made to support completion of all deliverables in the
plan, including availability of subject matter experts, overall project dependencies,
budget and resource allocation approvals, tool availability, etc].
Completion of all deliverables outlined in this plan assumes the following:

Beta testing goes as planned


Teams ability use software needed

Constraints
We have identified the following constraints on completing documentation activities
for [Project Name]:

Knowledge of softwares needed to complete construction

Resources
[Describe the resources and level of effort estimates required to complete all the
deliverables. Include the metrics use to calculate level of effort]
[Example:]
Completing all documentation deliverables as outlined requires the following:
# full-time content developers for XX weeks.
# part-time content developers for XX weeks (50% allocation)
# full-time design/UI specialist for XX weeks
1 editor for xx weeks
1 part-time graphics specialist for xx weeks.
YY hours per subject matter expert time for initial interviews and draft
reviews
1 part-time content publisher for XX days
We estimate these resource requirements using the following metrics:
Content development estimated at 400 topics x XX hours of
development per topic
Editing requirements estimated at XX hours per topic.
Content reuse estimated at XX percent of total content for all
deliverables
Current publishing workflow requires XX hours to produce web-ready
content

Deliverable 2: FAQs
Goals and Objectives
The goal of FAQs is to answer basic questions that the user faces. We will also
hopefully allow some troubleshooting thru the FAQ section of the app.
Audience
The main audience for this user-facing application would be the initial app user. This
user will most likely be in their 20s-30s and own a smartphone. They will most likely
live within 30 miles of a large metropolitan area, and they either don't have access
to a large vehicle or don't have a vehicle at all.
Approach
Since the app concept is relatively new to the market ease of use will be a key
focus in the development. The user will most likely be tech savvy so that works into
our favor.

Initial Outline
Series of around 10 questions that Mover app users might encounter when using
the app.

Work Breakdown and Expected Review Cycle


[List the planned number of draft cycles and what will be included in each cycle.
Identify SME reviewers based on the type of content included (e.g. developers,
business analysts, product manager, help desk manager, etc.]

1. Content plan
a. Content plan creation
b. Content plan review and update
2. Draft 1
a. Written by Taylor
b. Reviewed by Jackson and Brandon
3. Draft 2
a. Re-written by Jackson
b. Reviewed by Taylor and Brandon
4. Beta Testing
a. Administered by Brandon
b. Reviewed by Taylor and Jackson
5. Final Draft
a. Written By Jackson
b. Final review by Taylor and Brandon
6. Files sent to production

Timeline and Milestones


Assumptions
[Delineate any assumptions made to support completion of all deliverables in the
plan, including availability of subject matter experts, overall project dependencies,
budget and resource allocation approvals, tool availability, etc].
Completion of all deliverables outlined in this plan assumes the following:

Beta testing goes as planned

Constraints
We have identified the following constraints on completing documentation activities
for [Project Name]:

Knowledge of softwares needed to complete construction

Deliverable 3: User Walk Thru


[Include the following information for each deliverable.]
Goals and Objectives
The goal of this objective is create a simple walk thru for the user as they first open
the app. This will hopefully minimize confusion as it allows the user to use the app
with guidance before getting thrown into it alone.
Audience
The main audience for this user-facing application would be the initial app user. This
user will most likely be in their 20s-30s and own a smartphone. They will most likely
live within 30 miles of a large metropolitan area, and they either don't have access
to a large vehicle or don't have a vehicle at all.
Approach
Our approach for the objective of User walk thru should be inviting and modern. So
that the user feels comfortable about using the app and comfortable with the
usability.

Initial Outline
See guide in Deliverable #1. Follow the flow of the app to create a simple walk thru.

Work Breakdown and Expected Review Cycle

6) Content plan
a) Content plan creation
b) Content plan review and update
7) Draft 1 Walkthru
a) Written by Brandon
b) Reviewed by Jackson and Taylor
8) Draft 2
a) Written by Jackson
b) Reviewed by Taylor and Brandon
9) Beta Testing
a) Administered by Taylor, Jackson, and Brandon
b) Files sent to testers by Brandon
10)
Revisions Made
a) Revised by Jackson
b) Reviewed by Taylor and Brandon
c) Cleanup
d) Release to production

Timeline and Milestones


Assumptions
Completion of all deliverables outlined in this plan assumes the following:

Beta testing goes as planned


Teams ability use software needed

Constraints
We have identified the following constraints on completing documentation activities
for [Project Name]:

Knowledge of softwares needed to complete construction

Timeline
Milestone

Start

Documentation Plan

Completi
on

Duration

10/25/201
6

Documentation Plan Approval

Mm/dd/yy
yy

Mm/dd/yy
yy

1 day

Deliverable 1 Content Plan Approval

Mm/dd/yy
yy

Mm/dd/yy
yy

1 day

Deliverable 1 Content Draft 1

Mm/dd/yy
yy

Mm/dd/yy
yy

14 days

Deliverable 1 Draft 2 Approval

Mm/dd/yy
yy

Mm/dd/yy
yy

1 day

Deliverable 1 Design completed

Mm/dd/yy
yy

Mm/dd/yy
yy

10 days

Mm/dd/yy
yy

Mm/dd/yy
yy

28 days

Deliverable 1 Final version approved

Mm/dd/yy
yy

Mm/dd/yy
yy

1 day

Deliverable 1 Release to Production

Mm/dd/yy
yy

Mm/dd/yy
yy

3 days

Deliverable 1 Published

Mm/dd/yy
yy

Mm/dd/yy
yy

2 days

Deliverable 1 Beta Testing Complete

[Complete for remaining


deliverables]