ABSTRACT

This chapter provides the software so that it will be well-used long after the development period has ended. This preparation includes creating user documentation, user forums, and other user support. Such preparation helps to ensure a successful handoff and integration of the software into the client’s ongoing mission-critical activities. The chapter reviews principles of good writing, especially as they apply to writing user documentation. It discusses ways of integrating documentation within the code base, so that users have access to immediate support while they are working with the software. The chapter explores the principles and practices of developing good user support for an open source software project. Four prominent types of user documentation are particularly valuable—on-line help, user manuals, FAQs, and live demos. The chapter demonstrates the architecture of embedded on-line help pages within the software using Homebase.