The XMLInfo Addin

is a Visual Studio extension. It gets installed with the Framework and is accessible from inside Visual Studio IDE trough the menu Tools. Depending on other existing Addins it may not be on the first position as shown in this image.

^{If the Framework is uninstalled its menu item will be removed along with its associated files.}


 
 

Figure 1: Accessing the XMLInfo Addin from the tools menu of VS IDE.

The Wizard Interface

XMLInfo Addin is designed as a Wizard with a number of tabs that the user has to fill in with information. This information is stored in an xml file (text) which will be added, if it is not already, to the project The order of filling in the data is not important and one can go back and forth without restriction.  The tabs are organised in a way that would make it easy for the user to manipulate them unrestricted.  Tabs can be disabled at will when users find that they don't serve their purposes.

The addin works in the context of a project.  That is, if we are in the context of a solution the addin will work in the context of the selected (current) project.  This way every project in a solution can have its own xml readme file, specific to its functionality.  Off course if a readme file is not needed just don't create one.

Using the Save button at any time a save of the file can be forced.  Otherwise the saving is done when the user finishes and exits the wizard. Note that the file can be saved as both xml or binary.  This option may be more attractive for companies that want to restrict the direct access of the developers to the readme files.

A simple html or text translationof the information provided can also be exported by using the Export button.  This is mostly provided for developers who are interested on how the end documentation would look like.  Nevertheless, remember that the documentation that you provide would became in the end part of a company (project, solution) wide documentation.

Exported files will be automatically saved into the project folder, but will not be added tothe project, nor is there an option to save them somewhere else.

^{The Save and Export buttons are available with any tab.}

Figure 3: The XMLInfo Addin wizard like interface.

Description of tabs

   

Description

The Description tab has all necessary information for the current project.  The user can fill in the name of the module (component, library...), the name of the  project and the associated documentation information.  This is information that can be used later on to track back specification and administration documents. Don't wary about versioning it is going to be captured later.  For now we need to fill this information in which will not change and will show the  stable initial versions that the project started with.

Use the description text box to fill in as much information about the project as you may find fit.  Be careful, however as this information usually makes it in readme files and other documentation  that usually is delivered to the customer

Figure 4: The XMLInfo Addin Description tab.

  
^{Warning:the "Information about project" area can be only filled in once.  When the addin is used again later (which is the normal operation) this information will be read only.  The idea is that we don't want the developer to mistakenly modify this information which she is not supposed to.}

System Requirements Tab

Any number of requirements can be captured here. Three categories are  provided, each with its own table.

• Hardware: captures hardware requirements for the current project. Examples would be hard disk, CPU, Memory etc.
• Software: captures software requirements like OS version, services, libraries, frameworks with their versions.
• Others.  this should capture anything that is not of the previous sort. Example temperature in the room  . .

^{This information can be altered at any later time  as needed.}

Figure 5: The XMLInfo Addin System Requirements tab.

Configuration Tab

The Configuration tab has two panels.  One (on the left) is used to order the structure of steps needed in the configuration of the current component.  At the begging there is only the Start node.  By right clicking new nodes can be added.  the structure is linear so there is only one level of nodes.  That is besides the Start node no other node can have sub-nodes.

It is expected that the user will add those nodes in the order of steps to follow to configure the current component. The next figure shows the first node being selected.


On the right side there is a text box that is attached to the nodes.  Description displayed and modifiable on this box is associated (saved/restored) with the node that is currently selected.

Figure6: The XMLInfo Addin Configuration tab.

^{Note: This information can be altered at any later time  as needed.}

Installation Tab

The Installation tab has also two panels.  On the left one can select a node and the right text box the associated information will be displayed.  Use the right pane to input information related to the selected node from the left pane.

The left pane has two main nodes attached to the root: Prerequisites and Installation.  Those nodes can not be removed, nor can the associated information be changed. Wright clicking while a node is selected will add a new sub-node which should refer to a step in the process of installation of the component that is described.  Node names are editable and they should be as explicative as possible..

Use the description text box to fill in as much information about the selected step as you may find fit.  Be careful, however as this information usually makes it in readme files and other documentation  that usually is delivered to the customer.

Figure 7: The XMLInfo Addin Installation tab.

^{NOTE: All the information contained in this tag can be modified at a later time.}

Versions Tab

The Version Tab is the heart of the XMLInfo Addin. It is the one that you will use the most as it is the one that tracks the changes that happen in your project as it goes trough its last steps in the lifecycle, the maintenance .
The left pane contains top version information. The format of the version name is not restricted so whatever way you decided to name/code your versions just go ahead and do it.  Starting at the root where there is the first ever delivered version.  Any number of versions can be added afterwards, as needed.

Figure 8: The XMLInfo Addin Versions only  tab view.

Figure 9: The XMLInfo Addin Versions with SCRs tab view.

^{NOTE: All the information contained in this tag can be modified at a later time.}

Deliverables Tab

The Deliverables Tab comprises a list of files that are to be delivered as part of the containing project with their modification time and size.  Files can be added and removed as needed..  The add button opens an explorer to help the user select whatever files she wants to select.  Remove button will
remove (from the list not file system) the selected file(s).

Figure 10: The XMLInfo Addin Deliverables tab.

^{NOTE: All the information contained in this tag can be modified at a later time.}

Documentation Tab

The Documentation tab contains a text box that the user can use to list documents that are delivered or are referenced by the delivered application.  Being a free text one can add any information related to documentation like other documents that could help understand the business logic or URLs.

Figure 11 The XMLInfo Addin Documents tab.

^{NOTE: All the information contained in this tag can be modified at a later time.}

Legal Notices Tab

The Legal Notices tab is designed to be used for specific legal notices. This is the place where held licenses are listed. Collaborators or software acknowledges also can be listed.  This information can be used at a later time to generate acknowledge and legal terms needed for publishing or commercialization of the project deliverables.

Figure 12: The XMLInfo Addin Documents tab.

^{NOTE: All the information contained in this tag can be modified at a later time.}