No edit summary |
No edit summary |
||
| Line 1: | Line 1: | ||
| − | <p class="MsoNormal">This project will use DITA to create new documentation. We have been given access to Microsoft's current documentation in DITA format, which will allow us to reuse some of the information in their current help |
+ | <p class="MsoNormal">This project will use DITA to create new documentation. We have been given access to Microsoft's current documentation in DITA format, which will allow us to reuse some of the information in their current help system. We will add content and republish all help and associated documents to match the new features and functions. Any new information required for the bug fixes will also be edited in the documentation and republished.</p> |
<p class="MsoNormal">Senior writers assigned to this project are very proficient in using DITA to create documents. It will be their job to assist the junior writers in becoming more experienced in using DITA.</p> |
<p class="MsoNormal">Senior writers assigned to this project are very proficient in using DITA to create documents. It will be their job to assist the junior writers in becoming more experienced in using DITA.</p> |
||
| Line 5: | Line 5: | ||
<p class="MsoNormal">For each new feature, we will be creating new sets of topics. Each high level topic (i.e. new feature) will have sub topics associated with it as follows:</p> |
<p class="MsoNormal">For each new feature, we will be creating new sets of topics. Each high level topic (i.e. new feature) will have sub topics associated with it as follows:</p> |
||
| − | <p class="MsoNormal" |
+ | <p class="MsoNormal"> |
| + | </p> |
||
| ⚫ | |||
| + | |||
| ⚫ | |||
*Numbered steps on how to use the feature |
*Numbered steps on how to use the feature |
||
*Optional uses, optional methods of accessing the feature, etc. (if applicable) |
*Optional uses, optional methods of accessing the feature, etc. (if applicable) |
||
*Troubleshooting |
*Troubleshooting |
||
| − | <p class="MsoNormal" |
+ | <p class="MsoNormal"> |
| + | </p> |
||
<p class="MsoNormal">Once the topics and sub-topics have been created, their content added and have been mapped appropriately, they will be republished. Republishing formats will include paper documents, PDF files, online help files, and publication to the online Microsoft help forum. Microsoft style and formatting will be applied to all documents when they are published.</p> |
<p class="MsoNormal">Once the topics and sub-topics have been created, their content added and have been mapped appropriately, they will be republished. Republishing formats will include paper documents, PDF files, online help files, and publication to the online Microsoft help forum. Microsoft style and formatting will be applied to all documents when they are published.</p> |
||
Latest revision as of 19:47, 28 November 2013
This project will use DITA to create new documentation. We have been given access to Microsoft's current documentation in DITA format, which will allow us to reuse some of the information in their current help system. We will add content and republish all help and associated documents to match the new features and functions. Any new information required for the bug fixes will also be edited in the documentation and republished.
Senior writers assigned to this project are very proficient in using DITA to create documents. It will be their job to assist the junior writers in becoming more experienced in using DITA.
For each new feature, we will be creating new sets of topics. Each high level topic (i.e. new feature) will have sub topics associated with it as follows:
- General information (how the feature works) and examples of how this functionality can help the user
- Numbered steps on how to use the feature
- Optional uses, optional methods of accessing the feature, etc. (if applicable)
- Troubleshooting
Once the topics and sub-topics have been created, their content added and have been mapped appropriately, they will be republished. Republishing formats will include paper documents, PDF files, online help files, and publication to the online Microsoft help forum. Microsoft style and formatting will be applied to all documents when they are published.