br1_2

ap1_1

ug1_1

faq

BROCHURES

DEV DOCS & API's 

USER GUIDES

F.A.Q.

 

                   
                                      


Frequently Asked Questions
 

 


 

Home

 

Who is Intuitive Documentation Ltd?
We are a small company based in West Lothian, Scotland.
Started in 2010 by Alan Stirling, a Technical Author, Software Engineer, and Occasional Musician, we aim to evolve into being the byword for excellence and professionalism in Technical Writing.

I write my own User Guides. Why do I need a Technical Author?
Writing clear, succinct instructions and processes may seem simple but it is not. A Technical Author writes without making assumptions about the user’s knowledge and abilities, writes logically about how to achieve a task goal, and writes with simplicity and clarity.
Taking often complex and non-intuitive processes and translating them into a set of instructions that anyone can follow is exactly where the strength of a good Technical Author lies. Well-written, clear instruction manuals can often mean the difference between interest and frustration in a product.

Why are there no prices on the website?
Due to the complexities and differences of each authoring project, it is impossible to provide a price list. Each project is price based on the requirements of that project and is itemised, based on the project Statement of Work.
Full-itemised billing is provided as standard and there are never any hidden costs.

How do I get a quote?
Contact us to discuss your project requirements and we can give you a no obligation, general estimate. Once we produce a Statement of Work, we can give you an exact quote that will be valid for thirty (30) days.

When should I start looking to get my Documentation produced?
It’s great to be involved in a project from the start but in reality documentation can start being produced only when GUI and Feature Lock has taken place.  Extra cost and time may be added if major changes are required to documentation due to unexpected or unplanned-for changes in your application design.

How involved will I be in the production of my documentation?
There will be draft delivery dates defined in the project workflow where you can check the progress and quality of your documents, though we are happy to discuss progress with you at any time.
We are always aware that your documentation is often the first thing that the end-user sees of your application.
All User Guide style documents must go through both Technical Review (for accuracy of process) and Peer Review (for demographic suitability of voice, pace, and language).  Your senior team members involved in the project carry out these reviews.

I need to make major changes to the project, does that affect the Cost.
It depends if the changes affect the way the application looks and works, and ultimately how much of the documentation requires re-writing.
More time, and cost, may be added if unexpected changes are required. We are aware that changes are sometimes imposed upon developments mid-project so you need to let us know as soon as you can of any new changes pending.

I have no documentation for my project and am unsure of exactly what I need. Help!
Feel free to contact us with no obligation, and we will be happy to discuss your requirements.

What is the project ‘Workflow’?
The project (process) workflow is a clearly defined series of steps that provide a backbone for every stage of a project. All documentation produced by us follows this workflow, which ensures that no stage of the project can begin until the preceding stage is complete to the satisfaction of all decision makers involved in the project.

I already have documents but need them edited or updated.
We are happy to edit or update your own documentation.  Please contact us to discuss your requirements.

Do you design websites?
No, we are happy to write the text copy for websites and work with your designers on a consultancy basis.
If you need a full website solution go to our ‘Useful Links’ page.

Do you make any other marketing stuff like videos?
No, but we are happy to produce any text based marketing collateral you may require, and are happy to work with your designers on a consultancy basis. We can also provide you with links to marketing specialists with whom we have worked.


 

Home

 

 


 

 






 

lhbg