Professional Documents
Culture Documents
the content. online help pages can be faster and easier to use than printed doc
umentation because the reader can navigate directly to a page or topic without h
aving to skim through other material.
organize content logically: locate the most important part of the inform
ation at the top to keep the readers attention and make a good use of larger, bo
lder typefaces and headings.
SPECIFICATIONS:
- detail the required attributes of a product or project. they could inc
lude information about requred materials, dimensions or workmanship for a buildi
ng project
- poorly worded specifications can lead to costly or even dangerous mist
akes, so it's important ot be as clear as possible when writing them
- you should write your sentences in the present tense, using the active
voice. Breack down any long sentences and paragraphs into shorter commands and
lists to prevent confusion.
- you can also include charts and diagrams if they're appropriate
- your use of terminology should be consistent to the words you us aren'
t open to interpretation. avoid using different terms to refer to the same conce
pt or using one term with different meanings.
- avoid weak words with relative meanings such as "very, simple, normal
or effective", instead replace these with more precise terms
MANUALS:
- a manual is meant to guide readers through particular processes in the
ir entirety (?). like other documents that aim to instruct, manuals are document
that many readers turn to only as a last resort. so it's important that they do
n't confuse or frustrate readers.
- you should consider the level of expertise your readers will have and
choose your words carefully so your directions are as clear and straightforward
as possible.
- you should use the imperative voice because it's the most direct. also
be specific and include whaterver detail is necessary to keep your directions c
lear and unambiguous
- in a manual, you can include definitions in the main text or in either
footnotes or a glossary. Generally you should place longer desciurptions in sid
ebars, separating them from the main contento to avoid disrupting the flow of th
e directions.
- warnings should also be separated from other text and highlighted in s
ome way (by using bold typeface or placing them in a separate text box).
------------------------------------------------WHICH IS THE BEST TYPE OF ARTICLE FOR ME?
ARMAR UNA TABLA CON LOS TIPOS DE TEMPLATE A UTILIZAR SEGUN EL TIPO DE SITUACION