Methodology
| Home |
| Documentation |
| KM Consulting |
| Training |
| Experience |
| Methodology |
| Downloads |
| Endorsements |
| About Us |
Minimalist Documentation Method
The underlying philosophy of Wordware's Minimalist Documentation Method is to deliver just-in-time information (NOT just-in-case information). This method adopts a chunking approach to break information into tasks and topics. Bite-size chunks enable timely responses to document changes and are easily re-assembled to reflect new business requirements.
Minimalist documentation is characterised by four key features:
- It is task-focussed
- Information types are clearly distinguished: guidance for tasks and reference for topics
- Tasks and topics are written as self-contained chunks
- A unique layout presents information for quick intake.
Our Minimalist method is complemented by a suite of documentation techniques that include Multi-level Documentation, Simplified English, and Print-on-Demand.
Together they cover the four R s in documentation:
• Retrievable• Relevant
• Readable
• Reusable.
Multi-level Documentation
The documentation we deliver is provided on a need-to-know basis. Multi-level documentation supports this by making documentation Relevant for specific audience groups:
• Novice• Intermediate
• Expert.
At each level, the layer of information revealed is delivered in a way that best suits the target reader.
Simplified English
Wordware develops Readable documents and Web pages using Plain English. Plain English predates Simplified English (having been in use before the early 90's when Simplified English-a form of industry-specific controlled English, came into existence).
We adhere to the AGPS Style Manual. Our in-house style guide promulgates many of the guidelines found in most of the Simplified English standards:
• Write procedures in the active voice• Make instructions as specific as possible
• Keep sentences as short as possible
• Use bullet lists as appropriate.
We also write to client specifications-for example, Australian Defence Standard - DEF (AUST) 5629 - Production of Military Technical Manuals . We are currently establishing procedures and standards to support the ASD/AIA Specification 1000D (S1000D) Issue 2.1 .
Print-on-Demand (PoD)
As an extension of our documentation services, Wordware is able to assist clients to publish their documents at a very affordable cost via Print-on-Demand. This means that documents are developed, published, stored, sold and delivered electronically. It does away with the exponential cost of conventional printing and storage of paper copies. It allows for the flexibility of producing a document with Reusable components, on request or when an order is received.
This digital supply chain facilitates the amendment process and ensures only the latest version is issued. PoD is a natural outcome of our writing techniques, quality standards and ability to maintain a controlled document environment.
