Although publishing documentation on the Internet initially seems to be little different to publishing in any other medium, there are a number of special considerations that need to be borne in mind. There are almost as many permutations of monitor resolution, colour rendering, browser types, operating systems and user ability, as there are websites. Website Managers will have to consider many capabilities and standards to ensure that data is available to the widest audience.
There can be enormous benefits when documentation is published on the Internet, both for the publishing body and the general user.
Information access
A well designed website offers users a broader range of information than is available to them through conventional media, when they want it and in a form they can use.
To achieve this, the website should make use of the number of ways the web helps users find the documents they are looking for such as search engines, menus, navigational aids, indices and links between documents. Web navigation should also help users find the information they want within the document.
Some information such as menu pages and document summaries will have to be written specifically to be quickly scanned and understood.
It may be appropriate to make documentation available in a variety of differing formats. For example, some users may find it easier to download and print an entire document in Portable Document Format (PDF) and read it offline, whilst other may prefer to read it in online and on -screen in the form of a sequence of HTML pages.
Accurate and up-to-date
The web is easier to update or correct than print. Documents contained on the website can be a point of reference for both the public and your staff. Some departments provide a copy of their website on their intranet to facilitate this. A 'What's New' section should be included and constantly updated so that users have a constant and familiar route to new and updated information.
To achieve accuracy, the maintenance of documents after publication should be planned and resourced. Each document should adhere to the site template and all data should be formatted in a consistent way. Particular care should be paid to the Cascading Style Sheet, which may be used to control the formatting of the website.
There can be enormous benefits when documentation is published on the Internet, both for the publishing body and the general user.
Information access
A well designed website offers users a broader range of information than is available to them through conventional media, when they want it and in a form they can use.
To achieve this, the website should make use of the number of ways the web helps users find the documents they are looking for such as search engines, menus, navigational aids, indices and links between documents. Web navigation should also help users find the information they want within the document.
Some information such as menu pages and document summaries will have to be written specifically to be quickly scanned and understood.
It may be appropriate to make documentation available in a variety of differing formats. For example, some users may find it easier to download and print an entire document in Portable Document Format (PDF) and read it offline, whilst other may prefer to read it in online and on -screen in the form of a sequence of HTML pages.
Accurate and up-to-date
The web is easier to update or correct than print. Documents contained on the website can be a point of reference for both the public and your staff. Some departments provide a copy of their website on their intranet to facilitate this. A 'What's New' section should be included and constantly updated so that users have a constant and familiar route to new and updated information.
To achieve accuracy, the maintenance of documents after publication should be planned and resourced. Each document should adhere to the site template and all data should be formatted in a consistent way. Particular care should be paid to the Cascading Style Sheet, which may be used to control the formatting of the website.
0 comments:
Post a Comment