A Document is a managed information record for a specification, manual, procedure, report, or similar material. Its record supplies identity, description, version, and maturity information; its associated files contain the digital content.
When to use it
- Use it when written information needs its own identifiable record and managed history.
- Use it to keep supporting product information connected to the engineering or work records that need it.
Key information
- Identity and classification: document ID, name, description, and document type.
- Content context: language, access category, and expiration date where relevant.
- Managed control: revision, state, owner, and workspace.
Common relationships
- File connects the Document record to its digital content.
- Item – Document connects an engineering item to its supporting document.
- Compliance Reference connects a Requirement to a supporting Document.
Working with this record
Create the record with a clear purpose, attach the intended content, and check that users can find it from the related item or work record. Review both the record revision and its file before using the document. Apply the available revision and lifecycle commands when the content changes.
Example
Operating Manual P-100 is a Document connected to Pump P-100. Pump Manual.pdf is its File. The manual can be identified and reviewed as a managed record while the PDF supplies the content that users read.
Choosing the right type
Choose Document for managed written information. Choose Drawing for an engineering drawing with drawing-specific details. Choose File for the uploaded content itself; a file name alone does not replace the document’s identity or purpose.
