Documentation Plan by Raizza Moldovan

Rubik's Futuro Cube User Manual Documentation Plan Prepared by:

Raizza Mae Moldovan Technical Communications Department Princip Inc.

Date:

September 30, 2013

Revised:

October 30. 2013

Approved by: Ansel Burtynsky Hynek Kornel Olaf Farber Robert Cundari Cc:

Date Date Date Date Robin Cyrus Justin Adams

Table of Contents 1

Executive Summary of Documentation Plan ........................................................................................ 3 1.1 Documentation Objective ................................................................................................................... 3 1.2 Time and Production Cost Estimates .................................................................................................. 3

Schedule ................................................................................................................................................ 6

Projected List of Final Documents ........................................................................................................ 7

Support Documents .............................................................................................................................. 7

Scheduling Considerations .................................................................................................................... 7 5.1 Documentation Phases ....................................................................................................................... 7 5.2 Writing Strategies ............................................................................................................................... 7 5.3 Dependencies...................................................................................................................................... 8

Review Process...................................................................................................................................... 8 6.1 Reviewers ............................................................................................................................................ 8 6.2 Sign-Off Signatures for Final Documentation ..................................................................................... 8

Production Requirements ..................................................................................................................... 9 7.1 Printing, Packaging, and Distribution .................................................................................................. 9

Proposed Table of Contents.................................................................................................................. 9

Documentation Plan Notes ................................................................................................................... 9

2 Rubik's Futuro Cube User Guide Documentation Plan

1 Executive Summary of Documentation Plan 1.1 Documentation Objective This is a documentation plan that outlines the strategy for the creation of Rubik's Futuro Cube User Guide, which will come with the package when the product is released and on the product's website on January 2014. It is addressed to Product Marketing and Product Development staff within Princip Inc. to inform them about the documentation efforts that will be undertaken for this release. The purpose of this documentation is to keep track of the project's progress. Also, to secure the support of the Product Marketing and Product Development staff, in the form of a commitment to: 1. Provide the information, tools, and personnel resources necessary (such as developers' time for interviews, walkthroughs, problem-solving) during research, documentation development and testing; and 2. Review and approve drafts and final documentation. The final deliverables for the for Rubik's Futuro Cube product are:  

Rubik's Futuro Cube User Guide Online HOWTO & FAQ

Scope of the information development activity in each of these documents includes research, writing, reviews, revisions and production of the final printed manual or HTML of each publication. Final documentation will be provided in the following formats: Document Rubik's Futuro Cube User Guide How-To and FAQ

Format Hard copy and PDF on the website On the website

Table 1 Format of documents

1.2 Time and Production Cost Estimates The writer estimates it will take 80 hours to successfully complete the documentation. This estimate takes into account that some of the work involves updating existing documents and creating new documents. The estimate also includes the following necessary tasks: Printed User Guide Design: 1. Create Content Plan 2. Review outline – Subject Matter Experts, marketing, customer support, other interested parties 3. Investigate printing options: provide specs to multiple printers, get quotes

3 Rubik's Futuro Cube User Guide Documentation Plan

Development: 4. 5. 6. 7.

Create first draft, usually without much art Perform SME content review and edit of first draft; do a copy edit if there's time Create second draft, complete with art and index Perform SME content review and edit, as well as full copy edit, of second draft

Alpha/Beta test: 8. Make final updates; should only be minor changes 9. Proofread entire document Production: 10. 11. 12. 13.

Submit master to printer Get proof back from printer Approve first production run Get first run back from printer

How-To and FAQs Design: 1. Outline 2. Review of outline by tech, marketing, other interested parties Development: 3. 4. 5. 6.

First draft, usually without much art Technical edit of first draft; copy edit if there's time In parallel, create all needed art Second draft, complete with art and index; submit to build for test integration

Integration and Test 7. 8. 9. 10.

Hook up context sensitive help (either writer provides IDs to programmer, or vice versa) Tech/copy edit of second draft; test of context sensitivity Final draft; should only be minor changes Proofread

"Deploy" 11. Submit to build for official inclusion in launched website

4 Rubik's Futuro Cube User Guide Documentation Plan

Tasks Subject Matter Experts Interviews Product Testing Writing, editing, formatting, revising Verifying procedures Translation of English source materials to Czech and French Quality assurance of PDF and printed files Print coordination Total

Time Estimate, In Hours 16 8 16 8 16 8 8 80

Table 2 Time Estimate

Note: Time estimates are subject to a variable of Âą10%. Review time is factored into the above estimate and is based on the defined review process. Any delay on the defined review process will result in additional time requirements. Tasks Illustrator fees (CA$50/hour) Printing of user guide, A3 both sides, grayscale (CA$0.20/pc x 10,000) Czech translation and accuracy check French translation and accuracy check Incidental costs (research, etc) Total

Amount in CA$ 200 2,000 1,500 1,500 500 5,700

Table 3 Production Cost Estimate

5 Rubik's Futuro Cube User Guide Documentation Plan

2 Schedule Activities SME Interview

Product testing Outline for User Guide, How-To & FAQs First Draft for User Guide First Review for User Guide First Draft for How-To & FAQs Verifying Procedures First Revising & Editing

Second Review Second Revising & Editing Third Review Translations for User Guide Translations Accuracy Check Final Changes Test print with printer Final Approval PDF creation & Printing How-To & FAQs Turnover

Description Interview sessions, gather information with SMEs and getting to know the product Information session, trying the product from the end user perception Formulate the content outline for the user guide, how-to & FAQs Put together the information gathered First review for the draft. Refer to review process on page 8. While draft for user guide is being reviewed, work on draft for the How-To & FAQs Verify information and procedures about the product Integrate the comments of SMEs, edit and clean up for 2nd review. Add illustrations. Second review for all deliverables. Refer to review process on page 8. Revise and integrate comments from 2nd reviewers Refer to review process on page 8. Outsource with Babel Stone for Czech and French translations Done by Babel Stone

Start Date Nov. 4, 2013

End Date Nov. 5, 2013

Nov. 6, 2013

Nov. 7, 2013

Nov. 7, 2013 Nov. 8, 2013

Nov. 7, 2013 Nov. 10, 2013

Nov. 8, 2013

Nov. 12, 2013

Nov. 11, 2013

Nov. 12, 2013

Nov. 13, 2013

Nov. 14, 2013 Nov. 15, 2013

Nov. 14, 2013 Nov. 18, 2013

Nov. 19, 2013

Verify everything matches with the User Guide. Make a test print with the printer Refer to review process on page 8. Send to printer; turnover of PDF to webmaster Send to the webmaster

Nov. 20, 2013

Nov. 21, 2013 Nov. 21, 2013 Nov. 22, 2013

Nov. 21, 2013 Nov. 21, 2013 Nov. 25, 2013

Nov. 26, 2013

3 Projected List of Final Documents Document User Guide

How-To & FAQs

Purpose Provides procedural information, tips, and troubleshooting with the Rubik's Futuro Cube Provide general and procedural information that addresses common questions and issues

Writer Philip Moncarz

Audience All users

Output PDF Print

Deadline 11/25/2013

Sunny Davis

All users Website prospective users

11/29/2013

Table 4 Projected list of final documents

4 Support Documents Refer to the following documents for additional information on the Rubik's Futuro Cube" ď&#x201A;ˇ ď&#x201A;ˇ

Futuro Cube Software Information Plan FW 405 Open Beta SDK multiple script support

5 Scheduling Considerations 5.1 Documentation Phases The creation of documentation involves the following consecutive phases: 1. 2. 3. 4. 5. 6. 7. 8.

Research Planning Writing Review Revising PDF preparation QA of PDF and printed user guide Printing and delivery

Only the third and fifth phases are the sole responsibility of the writer. The first and fourth phases require close and continuous cooperative efforts between the writer and subject matter experts. 5.2 Writing Strategies For this project to be successful, the writer requires access to all project documents on an accessible LAN drive. The development team will provide the writer with documentation of any changes to the project specifications because they may affect the final documentation. The writer requires a reasonable amount of access to the subject matter experts. And the writer will attend general team meetings, and any other meetings deemed necessary for the success of the documentation of the project.

5.3 Dependencies The following risks are identified as having potential to affect the delivery schedule:   

Dependence on current resources. To reduce the risk, the writer will forecast needs for developers' time as far in advance as possible. Access to the most current versions of all source documentation. Availability of SMEs. Availability of SMEs to answer questions and draft content from SMEs by stated deadline. Timeliness of reviews. Delay in turnaround of reviews may prevent on-time delivery. To reduce this risk, reviewers will have as much advance notice as possible of the requirements for a review.

6 Review Process The review and approval process for updated documentation is described below: 1. First and second review. Subject matter experts and designated reviewers review new material that has been created, and any changed material, and provide feedback; 2. Third review. Formal review. Writer completes revisions; 3. Final review. Writer sends revised (final) version to approvers for signoff. These approvers are Product Marketing Manager and Development Manager. In general, reviews are informal and are handled via email with comments placed on the PDF versions of the documents. Reviewers may also mark up printed copies of the documents and return to the writer for revisions. 6.1 Reviewers Review First Review Second Review Third Review Final Review

Reviewers Subject matter experts: Paul Janus, Ian Areola, Dyanne Aceron Ansel Burtynsky, Hynek Kornel Olaf Farber, Daniel Walls Olaf Farber, Daniel Walls, Robert Cundari

6.2 Sign-Off Signatures for Final Documentation The following people are responsible for the final sign-off on the documents for this project: Document User Guide How-to & FAQs

Reviewers Olaf Farber, Rober Cundari Daniel Walls, Rober Cundari

8 Rubik's Futuro Cube User Guide Documentation Plan

7 Production Requirements The writer will utilize Adobe InDesign CS6 where the text will be written and formatted due to the planned layout of the User Guide. Same tool will be utilized for producing the PDF format. Eclipse Kepler (4.3) will be used for the website How-to and FAQs but will initially be written in Adobe Framemaker before being handed to the webmaster. 7.1 Printing, Packaging, and Distribution Final printing and packaging of the Rubik's Futuro Cube User Guide will be handled by Jukebox Print. Distribution will be handled by Road Runners Worldwide. Mailing labels will be provided by the writer. Placement of the final PDF file, How-to and FAQs will be handled by the webmaster. The writer will provide the file location and dates for placement on the Internet.

8 Proposed Table of Contents There will be no table of contents for this project since the planned user guide is only one page.

9 Documentation Plan Notes All documentations on the development of the product is in Czech. Extensive interview sessions with all the developers and SMEs required. Futuro Cube logo has been changed. Update all documentation that uses the logo. Some developers might get confused with the How-To and FAQs between the Software Development Kit and the actual product, be cautious which project to talk about. The company likes short and concise documentation, make sure all deliverables are short and concise, too.