Arduino Microcontroller User Guide: Documentation Plan

Arduino microcontroller

User guide
Documentation Plan

Arvin J. de Castro

Table of Contents
I.
II.
III.
IV.
V.
VI.
VII.
Overview..3
i. Scope...............3
ii. Goals and Objectives..............................................................3
Target Audience...................................................3
i. Users................................3
ii. Task Description..........................................4
Usability Goals (Requirements).........................4
Specifications............................4
i. Platforms Supported................4
ii. Graphics........4
iii. Delivery Media......4
Process and Schedules...5
i. Milestones.......5
ii. Approvals......5
iii. Review Process5
iv. Change Control5
v. Printing and Distribution..........5
Resources.5
i. Technical Writing Staff.............5
Issues..5
I.
Overview
This documentation plan outline the strategy for updating all the
documentation for the Arduino microcontroller.
Scope
This documentation plans includes the development of updates to all
users. It covers updating:
- User Guide (Operation guide)
- Installation/Set up guide
Scope of the information development activity in providing updates to
the document includes writing, reviews, revisions, and production of the
final PDFs and printed copy of the document.
Goals and Objectives
This document will provide comprehensive but concise information, both
conceptual and procedural, to assist the audience in performing all task
associated with accessing the product, setting up the product software,
connecting it to an Arduino microcontroller, and writing and running a
simple code using the product.
II.
Target Audience
Users
The target audience for using the Arduino microcontroller consists of
computer engineering students and information technology students of
De La Salle University Dasmarinas. Students with no previous
experience with the product can learn how to install, configure, and run
the product.
Task Descriptions
Users can experience the product by performing the following:
a. Set up the Arduino software on a computer and connecting it to an
Arduino microcontroller.
b. Write and run a simple code using the Arduino microcontroller.
III.
Usability Goals (Requirements)

The updated documentation will achieved its goals if a user with no
previous experience with the product can successfully install, configure,
and run all document processing operations for the Arduino
microcontroller.
IV.
Document Specification
The following specifications address the content and publications plans.
Platforms Supported
All documents will be accessible in all platforms such as Smartphones,
Tablets, Desktop, and Laptop via PDF reader.
Graphics
Graphics will be included in the manual, it will consists of icons,
screenshots, and flowcharts. Graphics will be captured, created, and
modified using MS Paint and Adobe Photoshop.
Distribution
Documentation will be delivered in printed and digital format.
- PDFs of all documentation on the product will be given.
- Printed copy of the document.
V.
Process and Schedule

Milestones
Date
Documentation Plan
January 02
Initial review complete
January XX
Revisions complete
January XX
Final version approved
January XX
General Release/Published
January XX
Approval and Review Process
For approval, writer sends a copy to approvers for signoff. Reviews are
informal and are handled with comments placed on the PDF file of the
document or may mark up printed copies of the documents and return to
the writer for revisions.
Change Control
The changes or revisions of the documents will be handled as soon as the
remarks or comments is received by the technical writing staff.
Printing and Distribution
Printing the final version of the document and begin the distribution to
the customers. The online copy of the document will be available the
same day as the printed copy is distributed.
VI.
Resources
Technical Writing Staff
Arvin de Castro is the technical writer tasked with the documentation for
the Arduino microcontroller user guide.
VII.
Issues
None identified at the current time.

Arduino Microcontroller User Guide: Documentation Plan

Uploaded by

Copyright:

Available Formats

Arduino Microcontroller User Guide: Documentation Plan

Uploaded by

Document Information

Original Description:

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

Arduino Microcontroller User Guide: Documentation Plan

Uploaded by

Copyright:

Available Formats

Arduino microcontroller

Usability Goals (Requirements)

Process and Schedule

You might also like