RetroTechCollection:Technical documentation
 | This page is a RetroTechCollection policy. All editors should follow it. Propose changes on the Village Pump before making them. |
This policy sets the standards for technical documentation on RetroTechCollection: how vintage computing and gaming hardware is documented for repair, restoration and preservation, what counts as acceptable documentation, and what a hardware article should contain.
Purpose
[edit source]RetroTechCollection is a technical reference for repairing and maintaining vintage computing hardware. All articles must provide verifiable, accurate technical information that enables users to safely diagnose, repair, and restore classic systems.
Hardware coverage requirements
[edit source]Documentable hardware
[edit source]Hardware is considered documentable when:
- Official service documentation exists (service manuals, schematics, parts lists)
- Technical specifications are available from manufacturer sources
- Component-level repair information can be verified
- Safety procedures for the hardware type are documented
Non-documentable hardware
[edit source]Hardware that lacks sufficient technical documentation includes:
- Prototype or one-off systems without service documentation
- Hardware with only community speculation about specifications
- Systems where repair procedures cannot be safely verified
- Hardware covered only by non-disclosure agreements
Technical source requirements
[edit source]Primary sources
[edit source]Preferred sources for technical documentation:
- Official service manuals and technical documentation
- Engineering schematics and circuit diagrams
- Component datasheets from manufacturers
- Official parts catalogs and service bulletins
- Factory training materials and service courses
Secondary sources
[edit source]Acceptable supporting sources:
- Established technical websites with documented procedures
- Published books on hardware repair and restoration
- Academic papers on vintage computing systems
- Well-documented community repair guides with verified procedures
Unacceptable sources
[edit source]Sources that should not be used as primary documentation:
- Unverified forum posts or comments
- Social media claims without documentation
- Video tutorials without accompanying technical documentation
- Personal blogs without verifiable technical backing
- Speculation or reverse-engineering without verification
Content standards
[edit source]Technical accuracy
[edit source]All technical information must be:
- Verified against official documentation when available
- Clearly marked when based on community testing
- Updated when errors are discovered
- Cross-referenced with multiple sources for critical safety information
Safety
[edit source]Pages whose procedures involve mains voltage or a CRT must carry a plain hazard statement, as set out in RetroTechCollection:Safety requirements. Mention other hazards, such as leaking batteries or solvents, where the procedure meets them.
Specification format
[edit source]Technical specifications should be presented:
- In standardized tables when possible
- With proper units and tolerances
- Referenced to source documentation
- Updated to reflect known variations or revisions
Documentation types
[edit source]Service manuals
[edit source]Official service manuals may be:
- Uploaded to support article content
- Referenced with specific page numbers
- Excerpted for technical specifications
- Used as primary sources for repair procedures
Complete manuals may be uploaded, including ones still under copyright, as long as the file page and the article state the source, the author or publisher, and the copyright holder. See RetroTechCollection:Service manual reproduction.
Schematics and diagrams
[edit source]Circuit schematics and technical diagrams:
- Should be legible and properly labeled
- Must include source attribution
- Can be redrawn or cleaned up for clarity, provided they stay accurate
- Should link to original documentation when available
Component information
[edit source]Component-level documentation includes:
- Part numbers and specifications
- Replacement compatibility information
- Failure modes and symptoms
- Testing procedures and expected values
Article structure
[edit source]Required sections
[edit source]Technical articles should include:
- Hardware overview with key specifications
- Common failure points and symptoms
- Diagnostic procedures
- Repair and maintenance procedures
- Safety warnings appropriate to the hardware
- References to source documentation
Recommended sections
[edit source]Additional sections that improve technical articles:
- Detailed technical specifications
- Board revisions and variations
- Upgrade and modification information
- Troubleshooting flowcharts
- Component-level repair guides
Verification process
[edit source]Technical review
[edit source]Technical articles benefit from:
- Review by experienced technicians
- Cross-verification of critical specifications
- Testing of repair procedures when possible
- Community feedback and corrections
Source verification
[edit source]Documentation sources should be:
- Verified as authentic when possible
- Cross-checked against multiple sources
- Updated when better documentation becomes available
- Attributed in full: source, author or publisher, and copyright holder
Copyright
[edit source]Manuals, schematics, datasheets, training material and photographs may be uploaded and reproduced in articles, in full or in part, as long as they are cited: the file page and the article state the source, the author or publisher, and the copyright holder. See RetroTechCollection:Copyrights. The upload form does not accept ROM images, disk images or program files.
Quality standards
[edit source]Minimum requirements
[edit source]All technical articles must:
- Provide accurate, verifiable information
- Include the hazard statement required by RetroTechCollection:Safety requirements where it applies
- Reference source documentation when available
- Use clear, precise technical language
Excellence indicators
[edit source]High-quality technical articles feature:
- Thorough coverage of the hardware
- Multiple verified sources
- Clear illustrations and diagrams
- Detailed troubleshooting procedures
- Active maintenance and updates