Document Actions
BPS Documentation.doc
(BPS Documentation.doc
- 2620Kb)
Table of Contents
(leave this page blank)
Introduction
This document is meant to set a guideline for creating documentation for technology projects. A description of the document, its intended audience, and any other pertinent information should go here.
Formatting
In order to have documentation consistent, please use the following guidelines.
TextUse the formatting palette and the predefined styles that are built into Microsoft Word. Do not adjust the size for individual text- try to always use the formatting settings. This will keep things consistent, easy, and helps with the table of contents creation
Use the various level Headings for your title headings
Use the normal style for the main body
Use the numbered/bulleted lists as appropriate
Use Bold type to indicate menu or button names and choices
PicturesFor printable documents it's probably best to take the screenshots at full resolution, and then resize them with Word.
After pasting or inserting your screenshot it will probably be set to In Line wrap. You'll want to change it to Tight or Square in most cases. The picture can then be moved to the intended location. As text is moved, the picture will move with the paragraph that it was inserted into.Use the Format Picture button
to resize the image.
Add a Table of Contents
When the documentation is finished a table of contents should be generated.
Move your cursor to the Table of Contents section.
Choose Insert -> Index and Tables…
Click the Table of Contents tab
Make any changes, and click ok.
Make any changes necessary for unneeded entries.
Versions
In order to keep the information intact, we will use Versions. Each time we save a milestone version of a document, we should save it as a new version.
Go to File -> Versions...
Click Save Now
Enter in a description of the version.Note what the overall milestone is
Include information about what has been changed or updated, including version numbers of the software.
Include your name in your listing (you can change the default name for Word in the Preferences: User Info window)
Page 2 of 3 Buffalo Public Schools Documentation
Buffalo Public Schools Documentation Page 1 of 3