Engl476576

Friday, May 04, 2007

Barker Chapter 12

Barker – Chapter 1; Getting the language right.
This chapter is mostly a series of tidbits advising you how to write certain topics.

1) Write about Actions rather than Functions.
Tell the reader what they can do with a tool, rather than describe the tool itself.
Bad:
Hyperlink: Inserts a hyperlink or edits the selected hyperlink.
Good:
Hyperlink: This button allows you to link selected text to other text or documents or edit the properties of selected hyperlinks.

2) Revise for the Active Voice
The active voice puts a subject at the beginning of each sentence, a verb in the middle, and a receiver of the action at the end.
Bad:
The file menu is used to…
Good:
You can use the file menu to…

3) Revise to keep Writing Simple
Break down complex sentences in order to enhance the reader’s ability to understand your meaning the first time they read it.

4) Revise to Build Parallel Structures
Try to be a little repetitive in your writing; it helps the readers mind organize steps, for instance, when they all begin with an action verb.

5) Add Operational Overviews
Use a paragraph to give a conceptual overview of the steps before listing the steps.

6) Make sure topic matches Heading
If your heading states something general, don’t get overly specific.

7) Don’t use too formal a tone
Often when writing, the writers tone takes on the feeling or a robot or telegraph. Try to sound slightly conversational, even in a business setting, to keep the user engaged.

8) Use Humor with Caution
There’s a lot of opportunity for humor to fall flat. Never use it in reference sections, seldom use it in procedures, occasionally in tutorials or background information.

Wednesday, May 02, 2007

Rockley Chapter 8 - Delinquent

I apologize for the late posting! Hope it hasn't caused too much inconvenience.

Chapter 8 - Information Modeling - Anne Peterson

In this chapter, modeling refers to formalizing a structure with writing and style guidelines, templates, and structured frameworks. Rockley says that it's critical to do a thorough analysis of information and its audience(s) when creating the model.

Rockley likens information architecture to the blueprints needed to build a house. It defines how content will be organized and structured for "information products" such as user guides, catalogs, documents, brochures, press releases, annual reports, intranets, Web sites, or technical specifications. Information architecture, done properly, requires a company to thoroughly examine all their content and catalog it.

Each of the information products listed above adheres to unique structural elements that identify them. It is important to understand the different types of structures. As content writing advances to Document Type Definition (DTD) it is even more important to understand structure and how it works.

The level of detail in a model depends on granularity, which determines the smallest possible piece of content that will be reused. There are different levels of granularity for authoring, resue, and delivery. Rockley says the greater the granual level, the greater the complexity of modeling, authoring, and managing the content.

After determining granularity, the model can start to be built. Some elements are mandatory and some are optional. There are information product models and individual element models.

Models can be made up of the following components:
  • Semantic information - uses semantic tags to describe what goes into each element
  • Base information - describes the common naming of each element using generic tags
  • Metadata - provides data about data
  • Architectural information - provides details on type of reuse

Rockley says that once the models are developed, they must be implemented throughout the organization so all authors and reviewers can use them as they create, edit, and review content.