Purpose
The purpose of this guide is to outline how create various functional specifications using Scaffolding Template.Scaffolding Forms & Templates is a Confluence add-on that we will be using to manage functional specs layout and make mass changesConfluence templates.
Creating Functional Specifications
...
- Data conversion: CNV-<Data Object ID> <Short Description>
- Other specifications: <Jira ID> <Short Description> (Jira ID will be have the format ERP-XX. See Custom Development Request on how to obtain Jira ID)
...
Go to the parent page of the respective functional specification, enter the title for the page, and click create.
| Note |
|---|
Ensure you review the Specification Acceptance Checklist while creating the document to ensure smooth passage through the review process. |
Appendix
Links to Jira
Use the Jira macro to link FS to their corresponding Jira request and development cards.
Search for the corresponding Jira cards and add them.
Labels
Labels are automatically added when functional specification are created. See below, to understand how labels are used
- The initial status is "In Progress". If you do not see the status, check if "functionalspec" label has been tagged to the document.
- Labels corresponding to FS types are added for reporting purposes.
Template Label Functional Specification - Enhancement enhancement Functional Specification - Form form Functional Specification - Interface interface Functional Specification - Story Definition report Functional Specification - Data Model report Functional Specification - User Interface ui Functional Specification - Workflow workflow
...
- If the page is newly created and has not been saved, you might see an error message under preview in "Edit Live Template Macro" pop-up. You can ignore this and save the macro setting and the page. After saving the page, the document layout will appear under preview.
- After saving the page if you see the following error, this could mean that the template name is wrong. Please check spelling, case and there are no additional spaces.
Updating documents created with Scaffolding templates
After the document has been created, click "Edit Contents" button add contents to the document.
...
Most fields have been created with rich text where you can create diagrams and tables. Please contact MUTHUSAMY-ext, Kunalan, if there is any issue with the field (e.g., wrong format or dropdown list).
...