Self Feedback: Evaluate Your Writing

 

Self Feedback: Evaluate Your Writing. 1

Table of Contents for this Reading. 1

Background: Your Written Component So Far1

Compare Your First Internally Published Component to the Final Version of the Component2

Can you learn from these differences about how to change your writing?. 2

Incorporate whatever you learn into your writing for the next Components. 2

 

 

At this point the first Component has progressed from draft, through your internal revisions.

You have made the information in the Component accessible to your Reader by careful use of bold text, headings, space and lines.  BUT you have not gone to any extreme to make the appearance of the Component fancy.  At this stage you are concerned with content and accessibility.  We do not want a flashy display to get in the way of the focus of the exercise: to polish the content and its accessibility.

You have now published the Component for your Components Readers' review (suggestions, comments, changes, additions).  Keep this first copy of the Component for your self-evaluation.

You have received feedback on the Component, and incorporated the suggestions, and then re-published the Component for the Components Readers. 

After a reasonable (but brief) cycle, you have a good draft of the Component.

Then you sent it to the editor for polishing of the grammar and wording.  You worked with your editor to resolve any questions. 

You've tested the Component and made appropriate corrections.

You've made the post-editing revisions, and re-published the Component for the Components Readers to examine for final tuning.

The Component is essentially done.

In this Step we want to compare and analyze the changes between that first internally published Component version (that you kept a copy of) with this "effectively done" Component.

The purpose is to improve your writing, with the goal of making the process faster and more efficient.  You may be able to incorporate the concepts behind the Components Readers' suggestions into your writing style, thus satisfying their needs earlier in the cycle.

Re-read the Component as you first published it for your Components Readers.  Now compare it with the essentially final version of the Component.

Look for differences between the two Components in:

O     Items covered

O     Depth of Coverage

O     Relation to product; Component testing results

O     Kept sight of Reader

O     Writing style

O     Wording

O     Grammar

O     Spelling

O     Any other differences

Can you make up any rules or guidelines so that the new Components that you write are more like the essentially done version?  Just spend a few minutes on this.

We improve ourselves by victories over ourselves. There must be contest, and we must win.         Edward Gibbon

However, do not let these rules or guidelines affect how you create the first draft of any Component.  That first draft -- or the initial writing of the first draft -- should be free-writing…you should only work to get your ideas written.

Instead, use your new guidelines to assist you when you Review and Revise your work before publishing it for your Components Readers.

 

 


Resources for Writing Great User Documents: Home

(c) 2006 Igetitnow! Training, Inc.