Documenting your application
Create documentation to engage stakeholders and give guidance to the end users and developers who interact with your application. You can generate a physical document or provide embedded information, based on your audience.
Use the following techniques to document your application:
- Creating project documents for stakeholders
Create an application overview to educate stakeholders about the features in your application and to review the development status of your project. To provide most relevant information, customize the application overview by including only specific chapters.
- Exporting a data model into a document
Share information about a data model in your application with stakeholders and developers so that they can quickly check if the data model includes all relevant information.
- Contents of application overview and data model documents
Provide stakeholders with high level information about your application by generating application overview and data model documentation. Customize the document to include only relevant information.
- Creating project documents for stakeholders in Dev Studio
Create project documents to educate stakeholders about the features in your application and to review the development status of your project.
- Creating a guide for end users
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.
- Describing features to end users
You can use a guided tour to showcase application features in real time. By providing information in a sequence of pop-up windows, you can help users discover functionality that is available on their current screen.