|
Applications, systems, programming interfaces, user and business requirements, and user interface
designs all pose interesting challenges in technical communication. Writing for the intended
audience is of paramount importance. Engineers want documentation that is well written,
unambiguous, but which is designed to facilitate their use of an engineering product. End-users
and business professionals want their requirements expressed in their own terminology and not in
the terminology of the technical solution. At the same time, end-users and business professionals
often need documents that bridge from their terminology to the technical concepts that form the
basis of the solutions on which they are increasingly dependant.
John has thirteen years experience in commercial practice specifying system and user requirements,
user interface designs, system designs, architectures, and application programming interfaces.
Having worked in most aspects of the development process John is sensitive to the needs of
engineering staff. John has also successfully worked as the user and business liaison to the
engineering process.
Why would you use John's services?
 System Specification and User Requirements
-
You want to document user or business requirements for a product or system.
-
You want to document business processes or user tasks.
-
You want to introduce current diagramming standards to your organization and need someone fluent in Unified Modeling Language (UML).
-
You are coordinating the development of a product. Your specification process is either looser than you want or you are spending enormous resource on detailed specifications that development can not use.
-
You want someone to work with your staff to improve your specification document.
-
You want someone to understand your current practice and introduce tools and practices that will improve the cost-effectiveness of your specifications process. You want specifications that reduce the effort of marketing staff as they track development, that reduce the effort development staff expends to understand requirements, and that helps to capture mission-critical intellectual capital in an easily accessible form.
API and Other Programming Documentation
- You want to document an API or sample application and you want a technical writer who understands high-level languages such as Java, C, C++, and Smalltalk.
- You want to capture design discussions and you need a technical writer who is proficient in programming languages, object technology, and software architecture to provide a useful record of the discussions.
- You want to provide UML diagrams to enhance the usefulness of your programming documenation.
|
