Uploaded image for project: 'JBoss Transaction Manager'
  1. JBoss Transaction Manager
  2. JBTM-1955

Review ALL documentation

    XMLWordPrintable

    Details

    • Type: Task
    • Status: Closed (View Workflow)
    • Priority: Major
    • Resolution: Incomplete Description
    • Affects Version/s: None
    • Fix Version/s: None
    • Component/s: Documentation
    • Labels:
      None

      Description

      I think we need to read through all the documentation looking for:

      1. Out of date stuff. For example, references to file locations in AS versions prior to AS7.
      2. Irrelevant stuff. For example: XTS documents the theory of heuristics, despite having no support for them in the current protocols or implementation.
      3. Incorrect stuff. No examples, but there could be some errors.
      4. Missing stuff. Most likely for new features, not yet documented.

      For 1. in particular, we should search across the entire documentation for other occurrences of the same issue, once found. For example, if a reference to bin/run.sh is found, then grep over all the other docs for other occurrences.

      I think we should divide up the docs between multiple people so as to not over-burden a single individual with what is likely to be a tedious task.

        Gliffy Diagrams

          Attachments

            Activity

              People

              • Assignee:
                tomjenkinson Thomas Jenkinson
                Reporter:
                paul.robinson Paul Robinson
              • Votes:
                0 Vote for this issue
                Watchers:
                3 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved: