Creating a guide for application developers and administrators
Create an application guide to direct users through a set of tasks. By providing instructional information, you can help users learn about the functionality that your application provides, configure complex settings, or extend features with limited assistance.
You add structure to an application guide by organizing related tasks into chapters. Each task can include instructional text and a link to supporting information, such as an external document or a landing page.
For example, you can create an application guide for migrating locally stored information to a database server. In the chapter for configuring your database, you can add tasks for creating tables, views, and users. In the task for creating users, you can supplement the instructions with a document that lists database privileges.
- Adding a chapter to an application guide
To organize related tasks, add a chapter to an application guide.
- Adding a task to a chapter in an application guide
To provide step-by-step information in an application guide, add a task to a chapter.
- Adding supporting information to an application guide
Add supporting information to an application guide to direct users to the resources that relate to their current task.
- Adding an application guide to a portal
Add your application guide to one or more portals so that users can access it.
Previous topic Changing the structure of a project document Next topic Adding a chapter to an application guide