Menu ▾ ▴

#189 Replace the CHM file with the internal documentation strategy

v1.1.x
closed
Erik Hänel
None
v1.1.0
Change Request
2017-05-05
2017-04-04
Erik Hänel
No

The CHM file has to be compiled and is not really versionable. Therefore it shall be replaced with the XML-derivated nhlp files.

Analysis:
The menu item associated with the CHM file has to be redirected to a call to the internal main article, i.e. help numere. This documentation article has to be modified correspondingly as it now needs to cover even the GUI specialities. The missing help files, which are the content of the CHM file, have to be created and associated with the documentation index file. Remark: use the update.hlpidx file for adding these new files.

Implementation:
The menu item was reassigned to the internal help files. Implementation test were passed successfully.

Documentation:
The CHM file was replaced and its contents were moved to the interal documentation files.

Tests:
Internal documentation strategy is working as expected. All documentation articles are available.

Discussion

  • Erik Hänel

    Erik Hänel - 2017-04-04
    • status: open --> accepted
     

  • Erik Hänel

    Erik Hänel - 2017-04-04
    • Description has changed:

    Diff:

    --- old
+++ new
@@ -1 +1,9 @@
 The CHM file has to be compiled and is not really versionable. Therefore it shall be replaced with the XML-derivated nhlp files.
+
+**Analysis:**
+
+**Implementation:**
+
+**Documentation:**
+
+**Tests:**
    • status: accepted --> analyzing
     

  • Erik Hänel

    Erik Hänel - 2017-04-04
    • Description has changed:

    Diff:

    --- old
+++ new
@@ -1,6 +1,7 @@
 The CHM file has to be compiled and is not really versionable. Therefore it shall be replaced with the XML-derivated nhlp files.

 **Analysis:**
+The menu item associated with the CHM file has to be redirected to a call to the internal main article, i.e. `help numere`. This documentation article has to be modified correspondingly as it now needs to cover even the GUI specialities. The missing help files, which are the content of the CHM file, have to be created and associated with the documentation index file. ***Remark:*** use the update.hlpidx file for adding these new files.

 **Implementation:**
    • status: analyzing --> implementing
     

  • Erik Hänel

    Erik Hänel - 2017-04-04
    • Description has changed:

    Diff:

    --- old
+++ new
@@ -4,6 +4,7 @@
 The menu item associated with the CHM file has to be redirected to a call to the internal main article, i.e. `help numere`. This documentation article has to be modified correspondingly as it now needs to cover even the GUI specialities. The missing help files, which are the content of the CHM file, have to be created and associated with the documentation index file. ***Remark:*** use the update.hlpidx file for adding these new files.

 **Implementation:**
+The menu item was reassigned to the internal help files. Implementation test were passed successfully.

 **Documentation:**
     

  • Erik Hänel

    Erik Hänel - 2017-04-05
    • Description has changed:

    Diff:

    --- old
+++ new
@@ -7,5 +7,6 @@
 The menu item was reassigned to the internal help files. Implementation test were passed successfully.

 **Documentation:**
+The CHM file was replaced and its contents were moved to the interal documentation files.

 **Tests:**
    • status: implementing --> testing
     

  • Erik Hänel

    Erik Hänel - 2017-05-05
    • Description has changed:

    Diff:

    --- old
+++ new
@@ -10,3 +10,4 @@
 The CHM file was replaced and its contents were moved to the interal documentation files.

 **Tests:**
+Internal documentation strategy is working as expected. All documentation articles are available.
    • status: testing --> closed
     

Anonymous
Anonymous

Add attachments
Cancel





MongoDB Logo MongoDB