Knowledgebase

Writing Documentation With Others Print

  • 0

Collaboration and contribution.

WHY MULTIPLE WRITERS CREATE PROBLEMS

Inconsistent terminology, structure and depth.

WHAT TO ESTABLISH

Shared conventions.

WHAT TO PROVIDE

A style guide and templates A glossary of agreed terms

WHY A GLOSSARY

Terminology inconsistency is the most visible sign of multiple writers.

WHAT TO ESTABLISH ABOUT CONTRIBUTIONS FROM SUBJECT EXPERTS

That they provide accuracy and someone else provides clarity.

WHY

Experts write for other experts, and they cannot see it.

WHAT TO ASK THEM FOR

The technical substance, not finished prose.

WHAT TO DO WITH IT

Rewrite it for the reader.

WHY

It is faster than requesting revisions.

WHAT TO ESTABLISH ABOUT REVIEW

Who reviews for accuracy Who reviews for usability Who decides

WHY A DECIDER

Review comments conflict and unresolved conflict stalls publication.

WHAT TO ESTABLISH ABOUT VERSION CONTROL

One authoritative source.

WHY

Documents edited in parallel diverge and merging them loses changes.

WHAT TO AVOID

Circulating documents as attachments for comment Multiple copies being edited

WHAT TO ESTABLISH

That contributions are welcomed and acted upon.

WHY

Contributors who see their input ignored stop contributing.

WHAT TO PROVIDE

Feedback on what was used and what was not.

WHAT TO ESTABLISH ABOUT CORRECTIONS

That anyone may report or make them.

WHAT TO MAINTAIN

A record of who owns what.


Was this answer helpful?
Back

Are you happy with your experience? Leave us a review on Trustpilot.


Trustpilot