Vestas style guide for technical documentation · Vestas style guide for technical documentation...
-
Upload
nguyenlien -
Category
Documents
-
view
247 -
download
2
Transcript of Vestas style guide for technical documentation · Vestas style guide for technical documentation...
![Page 1: Vestas style guide for technical documentation · Vestas style guide for technical documentation How to write technical documentation at Vestas Wind Systems A/S 24-11-2015, Susanne](https://reader031.fdocuments.in/reader031/viewer/2022021418/5ac5a3fa7f8b9aa0518e1c27/html5/thumbnails/1.jpg)
Vestas style guide for technical documentationHow to write technical documentation at Vestas Wind Systems A/S
24-11-2015, Susanne M. K. Diedrichsen, Technical Documentation, Vestas Wind Systems A/S
![Page 2: Vestas style guide for technical documentation · Vestas style guide for technical documentation How to write technical documentation at Vestas Wind Systems A/S 24-11-2015, Susanne](https://reader031.fdocuments.in/reader031/viewer/2022021418/5ac5a3fa7f8b9aa0518e1c27/html5/thumbnails/2.jpg)
Technical Documentation teamDenmark: 14 employees
India: 10 employees
+ currently 16 consultants
![Page 3: Vestas style guide for technical documentation · Vestas style guide for technical documentation How to write technical documentation at Vestas Wind Systems A/S 24-11-2015, Susanne](https://reader031.fdocuments.in/reader031/viewer/2022021418/5ac5a3fa7f8b9aa0518e1c27/html5/thumbnails/3.jpg)
Technical Documentation team
• Functions in the Technical Documentation team:
• Technical writingᅳ Production documentationᅳ Service documentation
• Editing• Illustrating/Illustrated Parts Catalogues• Translation
![Page 4: Vestas style guide for technical documentation · Vestas style guide for technical documentation How to write technical documentation at Vestas Wind Systems A/S 24-11-2015, Susanne](https://reader031.fdocuments.in/reader031/viewer/2022021418/5ac5a3fa7f8b9aa0518e1c27/html5/thumbnails/4.jpg)
Language at Vestas
• Vestas Wind Systems A/S:• Corporate language policy ᅳ Corporate language is UK English.ᅳ Must cover the entire organisation
• Technical Documentation department:• Different (more specific) set of rules• Style guideᅳ Vestas – How to Write ᅳ Initial (light) version
ᅳ Technical Documentation Style Guideᅳ Current version
![Page 5: Vestas style guide for technical documentation · Vestas style guide for technical documentation How to write technical documentation at Vestas Wind Systems A/S 24-11-2015, Susanne](https://reader031.fdocuments.in/reader031/viewer/2022021418/5ac5a3fa7f8b9aa0518e1c27/html5/thumbnails/5.jpg)
Technical DocumentationStyle Guide
![Page 6: Vestas style guide for technical documentation · Vestas style guide for technical documentation How to write technical documentation at Vestas Wind Systems A/S 24-11-2015, Susanne](https://reader031.fdocuments.in/reader031/viewer/2022021418/5ac5a3fa7f8b9aa0518e1c27/html5/thumbnails/6.jpg)
Technical Documentation Style Guide
• Why have a style guide• Safety.• Uniform documentation across manual types and technical writers. (Quality and
professionalism).• Cost savings (also with a view to translation). (Economy)
• Working with a style guide• All technical writers and editors have been introduced to the Technical
Documentation Style Guide and must adhere to it at all times when writing technical documentation.
• The editor group enforces the rules in the Technical Documentation Style Guide when making the editorial review of the technical documentation. If it is found that the document does not live up to the needed standards, the work can be returned to the technical writer for rewriting.
![Page 7: Vestas style guide for technical documentation · Vestas style guide for technical documentation How to write technical documentation at Vestas Wind Systems A/S 24-11-2015, Susanne](https://reader031.fdocuments.in/reader031/viewer/2022021418/5ac5a3fa7f8b9aa0518e1c27/html5/thumbnails/7.jpg)
Technical Documentation Style Guide
• Indexed book
• Print-friendly layout
• 1st copy printed and distributed in the technical writer/editor group
• Primary work tool
• Deeply rooted in the daily work
![Page 8: Vestas style guide for technical documentation · Vestas style guide for technical documentation How to write technical documentation at Vestas Wind Systems A/S 24-11-2015, Susanne](https://reader031.fdocuments.in/reader031/viewer/2022021418/5ac5a3fa7f8b9aa0518e1c27/html5/thumbnails/8.jpg)
Technical Documentation Style Guide
• All users of the Technical Documentation Style Guide can suggest changes, corrections, and improvements to it at all times.
• All input is collected and evaluated by a style guide team which comprises technical writers and editors.
• The editors update the Technical Documentation Style Guide and review it.
• The Technical Documentation Style Guide is updated 1-2 times a year. Only on rare occasions, would it be updated more often (error corrections).
![Page 9: Vestas style guide for technical documentation · Vestas style guide for technical documentation How to write technical documentation at Vestas Wind Systems A/S 24-11-2015, Susanne](https://reader031.fdocuments.in/reader031/viewer/2022021418/5ac5a3fa7f8b9aa0518e1c27/html5/thumbnails/9.jpg)
Examples from the Technical
DocumentationStyle Guide
![Page 10: Vestas style guide for technical documentation · Vestas style guide for technical documentation How to write technical documentation at Vestas Wind Systems A/S 24-11-2015, Susanne](https://reader031.fdocuments.in/reader031/viewer/2022021418/5ac5a3fa7f8b9aa0518e1c27/html5/thumbnails/10.jpg)
Examples from the Technical Documentation Style Guide
• The Technical Documentation Style Guide contains:
• An introduction to technical documentation
• Guidelines for technical writing
• Appropriate use of language
• Illustrations
![Page 11: Vestas style guide for technical documentation · Vestas style guide for technical documentation How to write technical documentation at Vestas Wind Systems A/S 24-11-2015, Susanne](https://reader031.fdocuments.in/reader031/viewer/2022021418/5ac5a3fa7f8b9aa0518e1c27/html5/thumbnails/11.jpg)
Examples from the Technical Documentation Style Guide
• An introduction to technical documentationᅳ Product namingᅳ Heading and titlesᅳ Tables and listsᅳ Referenced information
![Page 12: Vestas style guide for technical documentation · Vestas style guide for technical documentation How to write technical documentation at Vestas Wind Systems A/S 24-11-2015, Susanne](https://reader031.fdocuments.in/reader031/viewer/2022021418/5ac5a3fa7f8b9aa0518e1c27/html5/thumbnails/12.jpg)
Examples from the Technical Documentation Style Guide
![Page 13: Vestas style guide for technical documentation · Vestas style guide for technical documentation How to write technical documentation at Vestas Wind Systems A/S 24-11-2015, Susanne](https://reader031.fdocuments.in/reader031/viewer/2022021418/5ac5a3fa7f8b9aa0518e1c27/html5/thumbnails/13.jpg)
Examples from the Technical Documentation Style Guide
• Guidelines for technical writingᅳ Styles (writing styles and formatting styles)ᅳ Punctuationᅳ Non-breaking charactersᅳ Articlesᅳ Voiceᅳ Trademarks and product names
![Page 14: Vestas style guide for technical documentation · Vestas style guide for technical documentation How to write technical documentation at Vestas Wind Systems A/S 24-11-2015, Susanne](https://reader031.fdocuments.in/reader031/viewer/2022021418/5ac5a3fa7f8b9aa0518e1c27/html5/thumbnails/14.jpg)
Examples from the Technical Documentation Style Guide
![Page 15: Vestas style guide for technical documentation · Vestas style guide for technical documentation How to write technical documentation at Vestas Wind Systems A/S 24-11-2015, Susanne](https://reader031.fdocuments.in/reader031/viewer/2022021418/5ac5a3fa7f8b9aa0518e1c27/html5/thumbnails/15.jpg)
Examples from the Technical Documentation Style Guide
• Appropriate use of languageᅳ Conventions of UK Englishᅳ Correct use of verbsᅳ Abbreviationsᅳ Conventions for numbers and unitsᅳ Punctuationᅳ Vestas Term
![Page 16: Vestas style guide for technical documentation · Vestas style guide for technical documentation How to write technical documentation at Vestas Wind Systems A/S 24-11-2015, Susanne](https://reader031.fdocuments.in/reader031/viewer/2022021418/5ac5a3fa7f8b9aa0518e1c27/html5/thumbnails/16.jpg)
Examples from the Technical Documentation Style Guide
![Page 17: Vestas style guide for technical documentation · Vestas style guide for technical documentation How to write technical documentation at Vestas Wind Systems A/S 24-11-2015, Susanne](https://reader031.fdocuments.in/reader031/viewer/2022021418/5ac5a3fa7f8b9aa0518e1c27/html5/thumbnails/17.jpg)
Examples from the Technical Documentation Style Guide
• Illustrationsᅳ Illustration format, size, and resolutionᅳ Photographic compositionᅳ Callouts for illustrationsᅳ No text in illustrations
![Page 18: Vestas style guide for technical documentation · Vestas style guide for technical documentation How to write technical documentation at Vestas Wind Systems A/S 24-11-2015, Susanne](https://reader031.fdocuments.in/reader031/viewer/2022021418/5ac5a3fa7f8b9aa0518e1c27/html5/thumbnails/18.jpg)
Thank you for your attention
Copyright NoticeThe documents are created by Vestas Wind Systems A/S and contain copyrighted material, trademarks, and other proprietary information. All rights reserved. No part of the documents may be reproduced or copied in any form or by anymeans - such as graphic, electronic, or mechanical, including photocopying, taping, or information storage and retrieval systems without the prior written permission of Vestas Wind Systems A/S. The use of these documents by you, oranyone else authorized by you, is prohibited unless specifically permitted by Vestas Wind Systems A/S. You may not alter or remove any trademark, copyright or other notice from the documents. The documents are provided “as is” andVestas Wind Systems A/S shall not have any responsibility or liability whatsoever for the results of use of the documents by you.