USER GUIDES & SDK DOCUMENTS
By consulting with your designers, programmers, testers, and others involved in the software development process, we create clearly written, comprehensive User Guides, Installation Manuals, Tutorials, and SDK Documents. These documents can be made as single-source structures that output both paper-based manuals and context-sensitive help.
DOCUMENT LAYOUT
Aside from content, documents should also be attractive and formatted with a consistent style. Images, tables, columns, page numbers, headers, footers, and more all contribute to the readability of a document. Regardless of subject matter, we can layout and organize your document in a clear, professional manner.
PROOFREADING & EDITING
If your document is structurally sound, proofreading might be all you need. Proofreading will address typos, spelling, small grammatical mistakes, and inconsistencies.
For documents that need structural help or have factual errors or syntactical problems, proofreading is not enough. Copy editing will pull together a document’s structure and improve its flow. Editors might rearrange paragraphs, even chapters. Facts and references will also be checked.
Substantive editing involves rearranging, rewording, deleting, and adding sentences, paragraphs, and possibly entire pages. In some cases, a table of contents, an index, and footnotes are generated.
WRITING & EDITING PLAIN LANGUAGE
In many sectors it is important to ensure that communications are accessible to all stakeholders. Where possible, communication must be devoid of jargon and technical terminology that might cause misinterpretation or frustration on the part of readers. Creating plain language documents lowers the risk of miscommunication and enhances accessibility without sacrificing accuracy. Ardocs has expertise creating documents for English as a Second language and low literacy readers, as well as cross-culturally accessible materials.
See also Project Support.