definition glossary insurance

Design>Documentation
A listing of the most recently indexed works about Design and Documentation in the field of technical communication.

• Documenting User-Centered Design Best Practices
  When initiating or expanding the role of user-centered design (UCD) in an organization, consider documenting UCD best practices as they fit within existing processes and the best practice of other areas. Such documentation communicates the role and value of UCD throughout the organization in terms familiar to your organization. Because what best practices means varies from company to company, there is no single way to do this. Here are some questions to consider.
• Users Read Help Manuals Like an Encyclopedia, Not a Novel
  Users turn to help to look for a specific question, just as someone consults an encyclopedia for a specific question. No one reads the entire encyclopedia/manual, nor is anyone expected to. Well-written encyclopedias allow users to find information through indexes, tables of contents, alphabetical organization, and search fields.
• The Almighty Thud
  If you document everything, you are giving everything an equal weight. Do that for a complex system, and you are buried in detail. In any system there are some aspects that are more important than the others, key aspects of the system that once understood, will help someone to learn more. The art in documentation is to find how to document these aspects as clearly as possible. In this you emphasize these areas, and leave the details for the code.
• User-Guide-Driven Development
  In my work with Bumblebee I use an approach I call 'User-Guide-Driven Development,' or UGDD for short. The mechanics of UGDD is similar to that of Test-Driven Development (TDD), but before I write the test for a feature, I write a snippet of the user guide describing the feature I am about to implement.
• Structured Writing, Structured Documentation: What and Why?
  A brief comparison of two often-confused concepts.
• Analyzing Your Users and Needs Before Creating the Help Deliverables; Interview with Nicky Bleiel
  In this podcast, Nicky Bleiel says we should talk to as many users as we can — conducting on-site visits, sending surveys, gathering information from Marketing, Support, and other departments — so we can have a better understanding of our users’ needs and the formats and mediums that will work best for them. After completing this audience and needs analysis, we can then go out and create the deliverables that will best serve our users.
• How to Create User-Centered Documentation, Interview with Joe Sokohl
  In this podcast, Joe Sokohl explains how to create user-centered documentation by contacting, observing, and interviewing users to gather information about what types of information they use and the help deliverables they actually want.
• Are We Giving Readers What They Want, in the Way They Want and Need It?
  With all the talk about Web 2.0 and the attendant technologies, are readers actually being better served by documentation now than they were in the past?
• Getting to Expert
  The gaps in your documentation aren’t there because you haven’t consider a particular level of user; the gaps in your documentation are there because you haven’t considered how one level of user becomes another. How DO you get from Beginner to Expert?
• The Kind of Documentation Users Really Want
  Have you ever asked your users what kind of training materials they want, or how they prefer to learn software? This kind of information is critical to figuring out what help deliverables to produce.But really when it comes down to it, there are only so many options — printed manuals, short guides, interactive flash guides, videos, online help, live training, reference cards, context-sensitive help, workbooks and exercises, or, usually the favorite, someone to stand by their computer and answer questions whenever they need help.
• Systems That Get Better the More People Use Them
  In Publishing 2.0, Tim O'Reilly says Web 2.0 is 'any network effect that makes a system better the more people use it.' Web 2.0 isn’t just user-generated content; it’s harnessing the collective intelligence of your users to make your system better.
• Doc or Die
  This blog discusses documents and information designs “in the wild" - especially those that are exceptionally good or exceptionally bad.
• Is Your Website Poised to Deal With Its Growth?
  Every webmaster nourishes the dream that his or her website will make it the big way. This is very much human because people carry out any task in ardent hope. What is more human out here is that earthy fellows like us base our aspirations more on speculation rather than specific set of steps undertaken to bring the dream a bit closer to reality. And this is not all, particularly in case of growth of a site which brings newer problems in the wake of its growth.It cannot be disputed that you can probably get some good web hosting on economy price. But if you expect top of the line service on this price, acknowedge gracefully that your are just asking for the moon. Probably you are not catching up with wisdom that business needs decisive investments.
• Using a Database as a Feedback Mechanism
  The success of any technical document depends on the reliability of information presented in the document. A database can provide an informal mechanism for exchanging information about product development and support, The database system should have a user interface that is easy to use and does not require too many operations. Factors that must be addressed in the design, testing, and implementation of the database include the type of information, ownership, system maintenance, access control, and system development tools. Writers, who have special expertise in information gathering, can take the initiative and build support for the project.
• Write Once, Use Many: Why and How We Make Product Information Modular
  Faced with growing demand from customers for specific courses, addressing only their needs, in very short time-frames, we had to re-examine the way we worked. Patching together one-shot customized coursework was labor-intensive for a non-homogeneous and unsatisfactory result. Each new customer request required repetition of the same amount of effort. With reduced turnaround time and dwindling human resources, a solution had to be found.
• Reader-Centered Documentation Provides the Necessary Context
  A features-based approach to documentation is appropriate for reference manuals, where the goal is to provide information on something the reader already knows. This article explores how to meet the needs of the reader when providing documentation for user manuals.
• Enhancing Customer Satisfaction by Assuring Documentation Quality
  From the customer's perspective, an important and visible part of a product or service is its documentation. Bellcore's Technical Publications (Tech Pubs) organization uses a Quality Assurance (QA) program that focuses on enhancing customer satisfaction through delivering high-quality documentation. This program emphasizes a 'network' approach to documentation development, whereby technical writers can most efficiently use the support network of QA reviewers and management available to them. The Tech Pubs QA program draws on the needs of clients and the expertise of technical writers to strive to achieve the highest level of quality possible in producing documentation.
• Improving Document Quality Through Customer Visits
  In an effort to improve the quality of our documentation, our Information Development department personally visited over 80 of our customers in 10 different locations across the United States. Our goal was to find out what we needed to do to create documentation that would satisfy our customers' needs. We came up with a process for planning our visits, gathering the information from our customers, implementing their requirements, and increasing communication with them. From the visits, we not only made changes that immediately satisfied our customers, but we created an environment for them to work with us as a team.
• Improving Documentation with Learning Techniques
  It is important to recognize that because we all differ in our experience and background the learning process is different for each of us. Consequently, in our documentation we should by to put users on an equal footing by, for example, clearly and exactly defining terms we use and inc