Dita Wiki
OASIS DITA Machine Industry Subcommittee Wiki
The DITA TC Wiki serves the OASIS DITA TC for collaborative design work and for management of comment responses and other tracking documents.
For your consideration at the TC meeting on Tuesday, September 5th, 2006, I
propose that the TC officially establish a "DITA for machine industry" subcommittee. The attachment below provides the proposal name, goals, deliverables, chair, and initial membership for this proposed subcommittee.
Thank you for your consideration and support.
Chris Kravogel SeicoDyne GmbH phone: +41 41 534 66 97 christian.kravogel@seicodyne.com
Subcommittee name "DITA for the machine industry SC" (maybe someone comes up with a better name)
Working overview table of the main areas of work of the SC
Pos.
Status
Priority
Product Lifecycle Stage
Main Information
Referenced Information
Main Document
Referenced Document
Lead
0
complete
Product Planning
- Regulatory Compliance
- Part Availability
- Options List-
- User Requirements Document
- Product Planning Document-
Sissi
1
complete
1
Development
- Risk Management
- Technical Data
-- Wiring Diagram
-- Pneumatics/Hydraulics Plan
-- Product Specifications
-- Exploded View
-- etc.
- Materials List
- Tools List
- Warning and Hazard Information
- Hazardous Waste Handling Instructions- Prod. Lifecycle Plan
- Engineering Change Notices
- Material Safety Data Sheet
- Technical SpecificationJang
2
complete
Sales
- Materials List
- Exploded View
- Options List- Product Catalog
- Data Sheet- Modernization Instruction
Sissi
3
complete
Customization
- Compatibility Matrix
- Warning and Hazard Information
- Materials List
- Tools List
- Product Specifications
- Exploded View
- Part Availability
- Hazardous Waste Handling Instructions
- Technical Data
- Regulatory Compliance- Configuration Information
- Planning Documentation- Material Safety Data Sheet
Tim
4
complete
Production
- Production Plan
- Warning and Hazard Information
- Materials List
- Tools List
- Product Specifications
- Exploded View
- Part Availability
- Hazardous Waste Handling Instructions
- Technical Data
- Regulatory Compliance- Manufacturing Instruction
- As-Built Specification- Material Safety Data Sheet
Tim
5
complete
2
Training
- Technical Data
- Task Analysis
- Lesson Level Outline
- Lecture slides
- Assessments
- Student Guide
- Instructor Guide
- Work Book
- SCORM
- Ancillary- Functional Component Instruction
Robin
6
complete
Storage
- Warning and Hazard Information
- Materials List
- Tools List
- Material Safety Data Sheets
- Regulatory Compliance
- Hazardous Waste Handling Instructions
- Periodic Service Maintenance Schedule- Storage Manual
- Storage Instruction
- Transport InstructionTim
7
complete
2
Installation
- Warning and Hazard Information
- Materials List
- Tools List
- Product Specifications
- Exploded View
- Part Availability
- Hazardous Waste Handling Instructions
- Technical Data
- Compatibility Matrix
- Regulatory Compliance- Installation Manual
- Installation Instruction
- Storage Instruction
- Transport Instruction
- Modernization Instruction
- Diagnostics / Troubleshooting Manual
- Material Safety Data SheetsTim
8
complete
2
Commissioning
- Commissioning Instruction
- Test plan
- Test protocols- Commissioning Manual
- Modernization Instruction
- Diagnostics / Troubleshooting Manual
- Material Safety Data Sheet
- Storage InstructionJonathan
9
complete
2
Operation
- Technical Data
- Operation Manual
- Functional Component Instruction- Operation Instruction
- Installation Instruction
- Servcie Bulletin / Notes
- Material Data SheetChris
10
complete
Warranty
- Diagnostics / Trouble Codes
- Service Bulletin / Notes
Robin
11
complete
1
Maintenance
- Maintenance Procedure
- Maintenance Plan
- Periodic Service Maintenance Schedule
- What to do information
- How to do information
- When to do information
- Removal Procedure
- Exchange Procedure
- Restoration/repair Procedure- Technical Data
- Diagnostics / Trouble Codes
- Hazardous Waste Handling Instructions- Maintenance Manual
- Spare Parts Manual
- Service Bulletin / Notes
- Maintanance Card- Maintenance Instruction
- Installation Instruction
- Functional Component InstructionJonathan
12
complete
1
Diagnostics / Troubleshooting
- Diagnostics / Trouble Codes
- Technical Data
- Diagnostics / Troubleshooting Manual
- Diagnostics / Troubleshooting Instruction
- Material Data SheetRobin
13
complete
Modernization Upgrade / Update
- Removal Procedure
- Technical Data- Modernization Manual
- Change Pages- Modernization Instruction
- Installation Instruction
- Phase Out Instruction
- Material Data Sheet
- Service Bulletin / NotesChris
14
complete
Phase Out
- Recycle Information
- Wast Disposal
- Phase Out Instruction
- Decommissioning Instruction- Hazardous Waste Handling Instructions
- Material Data Sheet
- Tools List- Phase Out Manual
Chris
Publication Defintions [robin]
- Operation Manual: product operating information
- Installation Manual: information on how to install a product
- Preventive Maintenance Manual: operation and care information, is conducted to keep equipment working and/or extend the life of the equipment. Techniques help determine the condition of in-service equipment in order to predict when maintenance should be performed.
- Scheduled/Prescriptive Maintenance Manual: Periodic prescribed inspection and/or servicing of equipment accomplished on a calendar, mileage, or hours of operation basis. Its phases normally consist of inspecting, servicing, lubricating, and adjusting, as well as the replacing of parts, minor assemblies, and subassemblies.
- Corrective Maintenance Manual: Diagnostics, troubleshooting and repair information. Can be defined as the maintenance which is required when an item has failed or worn out, to bring it back to working order.
- Parts Catalog: illustrations and parts list for servicable repair parts
- Service Bulletins: updates to information in the service and maintenance manuals (other name maybe? Field Service Modifications: non-safety related service work)
- Service Bulletin Manual:
- Recall Bulletins: service work or parts replacement in connection with a recall notice
Initial Information to DITA Machine Industry Subcommittee Wiki
Goals The subcommittee has the following statement of initial goals:
- Develop a design for structured, intent-based authoring of content tailored to the needs in the machine industry:
- domains for specific areas of content (e.g. hazard statements - see also proposal #5)
- if necessary specific topics (e.g. special task types for preventive, corrective, predictive and condition based maintenance)
- tbd.
- Establish guidelines that promote best practices for applying standard DITA approaches to the needs in the machine industry:
- language reference / user guide
- powerpoint presentations
- training material.
Proposed chair Christian Kravogel, SeicoDyne GmbH (though open to other nominations or co-chair)
Deliverables Proposed initial work products for the subcommittee include the following:
- Task 1: Brainstorming: ideas and proposal collection.
- Task 2: Developing a top-level plan for topics and domains.
- Task 3: Design approval
- Task 4: Developing DITA DTDs schemas and processing, and piloting and validating the top-level designs against sample content.
- Task 5: Embedding the sample DTDs, schemas and sample documents to the DITA-OT demo section for field tests and feedbacks.
- Task 6: Reviewing the reports. Discussion in the TC, with recommended next steps (e.g. full or part integration into the DITA standard.)
Initial membership The following TC members have already contributed content for proposal #5 hazard statements and might be interested in joining the SC.
The following external person indicated interest to contribute ideas as invited expert to that SC:
- Prof. Sissi Closs, Comet Communications GmbH (OASIS Member)
Home pages for the OASIS DITA TC and this subcommittee
Member pages for the OASIS DITA TC and this subcommittee
Wiki home page for the OASIS DITA TC