Writing a Manual for Extranet
Lammi, Jenni (2022)
2022
All rights reserved. This publication is copyrighted. You may download, display and print it for Your own personal use. Commercial use is prohibited.
Julkaisun pysyvä osoite on
https://urn.fi/URN:NBN:fi:amk-2022121328417
https://urn.fi/URN:NBN:fi:amk-2022121328417
Tiivistelmä
This thesis is to document the different information that is gathered when writing any kind of a manual but especially for something to use on the Internet.
The steps documented are finding out useful information on how a manual could look like, what is the best way to have the message be read and understood.
This thesis showed how a manual for Extranet could be written and what needed to be taken into consideration when constructing said manual. This was done through online material as well as written articles on the subject. Such matters that needed the attention were language of the manual, structure as well as using different tools to make the manual more legible.
This thesis also included pointers on what should be discussed and instructed in the manual as well as what was the best way to convey the messages the writer of the manual wants to convey.
Also important is the visualisation of the manual as pictures are often much better and preferred when possible to use.
At the end, a finished manual was produced and circulated with the users of the Extranet.
In conclusion, the manual should have pictures, the language needs to be precise and it should be simple enough to use so that even non-native speakers find the Extranet easier to use.
The steps documented are finding out useful information on how a manual could look like, what is the best way to have the message be read and understood.
This thesis showed how a manual for Extranet could be written and what needed to be taken into consideration when constructing said manual. This was done through online material as well as written articles on the subject. Such matters that needed the attention were language of the manual, structure as well as using different tools to make the manual more legible.
This thesis also included pointers on what should be discussed and instructed in the manual as well as what was the best way to convey the messages the writer of the manual wants to convey.
Also important is the visualisation of the manual as pictures are often much better and preferred when possible to use.
At the end, a finished manual was produced and circulated with the users of the Extranet.
In conclusion, the manual should have pictures, the language needs to be precise and it should be simple enough to use so that even non-native speakers find the Extranet easier to use.