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 changes.

Creating Functional Specifications

1. Create a blank page with the the corresponding title and save the page.
   • 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)
2. After saving the page, edit the page and add the "Live Template" macro. A the pop-up shown below will appear. If the "Live Template" macro is added before saving the page, the error mentioned under troubleshooting will occur)
3. Set Type=template and under template fill up the corresponding template name as listed below:
   • [Scaffold]-Data Conversion Specification
   • [Scaffold]-Data Object Cleansing
   • [Scaffold]-Functional Specification - Enhancement
   • [Scaffold]-Functional Specification - Form
   • [Scaffold]-Functional Specification - Interface
   • [Scaffold]-Functional Specification - Report/Analytics
   • [Scaffold]-Functional Specification - User Interface
   • [Scaffold]-Functional Specification - Workflow
     
4. After entering the correct values, save the macro. The layout of the page should appear as shown below. Save the page to create the document.
   

Troubleshooting:

• 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).