1 of 3

Wiki Readme: Summary and Overview

Summary: This presentation is a Readme file which document locations in the DC-MHS Wiki format

  • Representative Screenshot of the DC-MHS Wiki (M-PIC is example in the Green Box - see Page 2):
  • Summarized table of Errata, Spec Versions, and Spec Revision definitions is on Page 3.

Latest DC-MHS Specifications:

  • Includes latest versions of DC-MHS Base Specifications
  • In some cases, IC review will be completed.

Errata and Supporting Documentation:

  • Includes Errata which has not been added to DC-MHS Base Specs
  • Includes useful documentation that may be used outside of specs

Inactive Documentation:

  • Includes Errata which has recently been included in Specs
  • Includes older versions of Specs
  • Includes older versions of CAD files

Connect. Collaborate. Accelerate.

2 of 3

Illustrative Use Case Examples

Consider M-PIC (“Green Box” example Slide 1)

​

  • Step 1 (Not Shown): M-PIC Errata is added to a running file for the M-PIC Workstream (labeled file “M-PIC Errata 1 and 2”).
  • Step 2 (Not Shown): “M-PIC Errata 1 and 2” is added to the Errata and Supporting Document section.
  • Step 3 (Not Shown): M-PIC Spec is revised to include the Errata 1 and 2.
  • Step 4: The revised M-PIC Spec (version 1.01) is posted in the Latest DC-MHS Specification section.
  • Step 5: Older revision of M-PIC Spec is moved to the Inactive Documents section.
  • Step 6: Errata, which is included in the specification, is moved to the Inactive Documents section.

​

​

Connect. Collaborate. Accelerate.

3 of 3

Documents Types and Use Cases

Attribute

Small Error Correction

Large Error Correction

“Minor Tick” ECN Version

“Major Tick” ECN Version

Revision Change

Naming example

1.0

Either Minor or Major Tick

Version 1.01

Version 1.1

Revision 2.0

Technical Example

Rounding a corner on a CAD drawing; fix a typo

Bug; if you follow spec fully you will fail

​

New HPM Board type (Type 2w)

​

Requirement

Publish Errata Addendum document; make correction

Spec change

Errata publish

Spec change

Spec change

Spec Change

New capability/constraint

No

No

Yes

Yes

Yes

New CLA?

No

No

No

No

Yes

Backwards Compatible?

Yes

Yes

Yes

Yes

No

WS Vote; inform Core

Yes

Yes

Yes

Yes

Yes

IP Change?

No

No or Yes

No

Likely Yes

Yes

Google Drive; Wiki Update; Inform at Monthly Meeting

Yes

Yes

Yes

Yes

Yes

IC Review

No

Yes (if new IP)

Yes

Yes (if new IP)

Yes

Push to Contribution Database

No

Yes

Yes

Yes

Yes

Connect. Collaborate. Accelerate.