Uploaded image for project: 'Technical Committee Administration'
  1. Technical Committee Administration
  2. TCADMIN-4469

Develop documentation of the OASIS document publication process

    Details

    • Type: Improvement
    • Status: In Progress
    • Priority: Major
    • Resolution: Unresolved
    • Component/s: None
    • Labels:
      None
    • Environment:

      Project Admin

      Description

      Describe key parts of the process currently handled by the OASIS staff "Document Process Analyst" position, within a description of the overall publication process.

        Attachments

          Activity

          paul.knight1 Paul Knight created issue -
          paul.knight1 Paul Knight made changes -
          Field Original Value New Value
          Status Open [ 1 ] In Progress [ 3 ]
          paul.knight1 Paul Knight made changes -
          Attachment The-OASIS-Document-Process-v1.0.md [ 12126 ]
          Hide
          paul.knight1 Paul Knight added a comment -

          Attaching initial rough outline. This is in markdown format. The-OASIS-Document-Process-v1.0.md

          Show
          paul.knight1 Paul Knight added a comment - Attaching initial rough outline. This is in markdown format. The-OASIS-Document-Process-v1.0.md
          Hide
          chet-oasis Chet Ensign added a comment -

          Paul, thanks. I was just thinking about this yesterday. I will have a look and see what I can add

           

          Show
          chet-oasis Chet Ensign added a comment - Paul, thanks. I was just thinking about this yesterday. I will have a look and see what I can add  
          Hide
          chet-oasis Chet Ensign added a comment -

          I created Gdrive OP/TC Shared Drive / Draft - Staff Resources / OASIS Publication Processes at https://drive.google.com/drive/folders/1FwBVmFiuPHANR0pItrIHWVq95H3-O3cm that we can use for collecting process documentation

          Show
          chet-oasis Chet Ensign added a comment - I created Gdrive OP/TC Shared Drive / Draft - Staff Resources / OASIS Publication Processes at https://drive.google.com/drive/folders/1FwBVmFiuPHANR0pItrIHWVq95H3-O3cm  that we can use for collecting process documentation
          Hide
          paul.knight1 Paul Knight added a comment -

          Very good idea - and thanks for putting the initial document there!

          Show
          paul.knight1 Paul Knight added a comment - Very good idea - and thanks for putting the initial document there!
          Hide
          paul.knight1 Paul Knight added a comment -

          I added a copy of the TAB's 2015 document "Checklist for Verifying the Editorial Quality of OASIS Specifications".

          This is kind of excessively/obsessively detailed relative to our current staff review practices, but very useful when applied in moderation.

          What needs to be updated or added is how OASIS staff should review the material being prepared for publication into the OASIS Library. I'll try to address that.

          Show
          paul.knight1 Paul Knight added a comment - I added a copy of the TAB's 2015 document "Checklist for Verifying the Editorial Quality of OASIS Specifications". This is kind of excessively/obsessively detailed relative to our current staff review practices, but very useful when applied in moderation. What needs to be updated or added is how OASIS staff should review the material being prepared for publication into the OASIS Library. I'll try to address that.
          Hide
          paul.knight1 Paul Knight added a comment -

          The Errata document might became an appendix (or section) of this larger process document...

          There is a separate "Errata Handling" document in the tca Kavi repo:

          The Errata doc will be further updated (wd25 is in process).

          Show
          paul.knight1 Paul Knight added a comment - The Errata document might became an appendix (or section) of this larger process document... There is a separate "Errata Handling" document in the tca Kavi repo: https://www.oasis-open.org/apps/org/workgroup/tca/download.php/71341/errata-v1.0-wd24.odt https://www.oasis-open.org/apps/org/workgroup/tca/download.php/71341/latest The Errata doc will be further updated (wd25 is in process).
          Hide
          paul.knight1 Paul Knight added a comment -

          Updated the document "The-OASIS-Document-Process-v1.1-in-process.md" in the Gdrive OP/TC Shared Drive / Draft - Staff Resources / OASIS Publication Processes, at https://drive.google.com/drive/folders/1FwBVmFiuPHANR0pItrIHWVq95H3-O3cm -used for collecting process documentation

          Show
          paul.knight1 Paul Knight added a comment - Updated the document "The-OASIS-Document-Process-v1.1-in-process.md" in the Gdrive OP/TC Shared Drive / Draft - Staff Resources / OASIS Publication Processes, at https://drive.google.com/drive/folders/1FwBVmFiuPHANR0pItrIHWVq95H3-O3cm -used for collecting process documentation
          Hide
          paul.knight1 Paul Knight added a comment -

          updated the document "The-OASIS-Document-Process-v1.1-in-process.md" with detailed description of the operation of symlinks and <base> tags.

          Show
          paul.knight1 Paul Knight added a comment - updated the document "The-OASIS-Document-Process-v1.1-in-process.md" with detailed description of the operation of symlinks and <base> tags. https://drive.google.com/file/d/1tkk_nS7cTnk2Jl2OhdsQWAqqiaWnrm9u/view?usp=drive_link
          Hide
          kelly.cullinane Kelly Cullinane added a comment -

          Paul Knight – can we find a way to name the documents in this folder so the file names put them in some sort of order. I am thoroughly confused.

          Show
          kelly.cullinane Kelly Cullinane added a comment - Paul Knight – can we find a way to name the documents in this folder so the file names put them in some sort of order. I am thoroughly confused.
          Hide
          kelly.cullinane Kelly Cullinane added a comment -

          Also, having these as txt files make it really difficult to work with the documents. We can't ask questions or make notes.

          I think we should talk about changing the formats.

          Show
          kelly.cullinane Kelly Cullinane added a comment - Also, having these as txt files make it really difficult to work with the documents. We can't ask questions or make notes. I think we should talk about changing the formats.
          Hide
          paul.knight1 Paul Knight added a comment -

          Updated the document "The-OASIS-Document-Process-v1.1-in-process.md" with info on the manifest driver file Added the manifest driver template file to the Google drive, and linked to it from the first file.

          Show
          paul.knight1 Paul Knight added a comment - Updated the document "The-OASIS-Document-Process-v1.1-in-process.md" with info on the manifest driver file Added the manifest driver template file to the Google drive, and linked to it from the first file. https://drive.google.com/file/d/1tkk_nS7cTnk2Jl2OhdsQWAqqiaWnrm9u/view?usp=drive_link
          paul.knight1 Paul Knight made changes -
          Assignee Paul Knight [ paul.knight1 ] Kelly Cullinane [ ID25708 ]

            People

            • Assignee:
              kelly.cullinane Kelly Cullinane
              Reporter:
              paul.knight1 Paul Knight
            • Watchers:
              3 Start watching this issue

              Dates

              • Created:
                Updated: