Page History

...

1. Determine if you need to create a feature design page for your new feature. You might need to create a feature design page if your feature:
   • Has externals that need to be debated or documented in the Trafodion manuals.
   • Includes changes to the overall overall architecture.
   • Has a complex, interesting, or new design that needs debating or illumination.
   • Affects performance, usability, availability, manageability, or scalability.

   If your feature is small and does not meet those criteria, you may only need to provide a summary in the feature's blueprint. To create a blueprint, go to the Blueprints for Trafodion page and click the Register a blueprint link. On the Register a new blueprint page, provide a single-paragraph description of your feature under Summary. For more information, see Blueprints.

   If you need to create a feature design page, name the page by its Launchpad ID or Blueprint name. To create the page in the wiki, see Creating a New Page.

   JIRA. 
   
   

2. Use the following template for ideas of topics to cover in your feature design page. Please copy and paste this wiki markup code into your feature design page and modify the headings as you see fit:

   ==Introduction==
   
   ===Purpose===
   
   ===Usage Scenarios===
   
   ==External Functionality==
   
   ===New Syntax===
   
   ====Command Name====
   
   =====Syntax Diagram=====
   
   =====Considerations=====
   
   =====Examples=====
   
   ===Default Settings===
   
   ===Configuration File Changes===
   
   ===Metadata Changes===
   
   ===New Error Messages===
   
   ==Architecture==
   
   ==Internal Design==
   
   ==Performance==
   
   ==Usability==
   
   ==Availability==
   
   ==Manageability==
   
   ==Scalability==
   
   ==Dependencies==
   
   ==Testing==
   
   <noinclude>
   
   
   

3. Once you complete your feature design page, put a link to it on the Feature Architecture and Design page.
4. Add the URL of your feature design page to the blueprint for your feature.
5. If a blueprint already exists for your feature, open the blueprint on the Blueprints for Trafodion page. Click on the Set the URL for this specification link (or Change details on the right) and enter the URL of your feature design page in the Specification URL field of the Edit specification page.
If a blueprint does not yet exist, you will need to create a blueprint for your feature. Go to the Blueprints for Trafodion page and click on the Register a blueprint link. On the Register a new blueprint page, enter the URL of your feature design page in the Specification URL field and provide a single-paragraph description of your feature under Summary. For more information, see BlueprintsJIRA for your feature.