 Application Document Wizard best practices
|
|
Follow Application Document Wizard best practices to create documents that meet your project and stakeholder needs.
General best practices
- Run the wizard iteratively: start with default values initially, save settings as you progress, and experiment with custom options last.
- When using an Application Document template, access the wizard from supported versions of IE browsers only.
- Avoid accidental loss of settings when you close the wizard by saving settings before you generate a document.
Step 1 - Select
When working with an Application Document template:
- Suppress class and ruleset
references — Check this box to generate content that is easily consumable by business users.
- Create links to rule forms within
document — Check this box to generate content that facilitates a functional review of your application.
- Start with default values in the section. You can slowly add chapters during subsequent iterations to actively manage your document's size.
- Refresh the section frequently. You can quickly preview the results without generating a physical document.
- Start with minimal selections in the section. You can add more detail in subsequent iterations based on different audiences.
- Run the wizard with only one case type selected at a time in the section. Smaller documents are easier to consume.
When working with a Specification Document template:
- Use column filters in the specifications table to manage the number of results.
- Generate focused documents by selecting only one case type at a time.
Step 2 - Define
Step 3 - Capture
Step 4 - Order
- Only use level 1 and level 2 headings in custom chapters. This helps streamline standard and custom chapters in the table of contents.
- Verify your flow action likelihood values are accurate. The table of contents uses these values to order subchapters when multiple execution paths exist.
- When sourcing a custom chapter by a Word Template, avoid using level 1 headings. The wizard inserts a line break between the chapter number and the chapter heading text.
