Editing RetroTechCollection:Technical documentation

{{shortcut|RTC:TECHDOC}}
{{policy}}

'''Technical documentation''' on RetroTechCollection refers to the standards and requirements for documenting vintage computing and gaming hardware for repair, restoration, and preservation purposes. This policy outlines what constitutes acceptable technical documentation and the standards for creating comprehensive hardware articles.

== Purpose ==

RetroTechCollection serves as 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 ==

=== Documentable Hardware ===
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 ===
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 ==

=== Primary Sources ===
'''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 ===
'''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 ===
'''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 ==

=== Technical Accuracy ===
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 Requirements ===
Articles covering repair procedures must include:
* Appropriate safety warnings for the hardware type
* Specific hazard identification (high voltage, toxic materials, etc.)
* Required safety equipment and procedures
* References to official safety documentation

=== Specification Format ===
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 ==

=== Service Manuals ===
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

Brief excerpts from service manuals for educational and repair purposes fall under fair use provisions. However, uploading complete manuals may require permission from copyright holders.

=== Schematics and Diagrams ===
Circuit schematics and technical diagrams:
* Should be legible and properly labeled
* Must include source attribution
* Can be enhanced for clarity while maintaining accuracy
* Should link to original documentation when available

=== Component Information ===
Component-level documentation includes:
* Part numbers and specifications
* Replacement compatibility information
* Failure modes and symptoms
* Testing procedures and expected values

== Article Structure ==

=== Required Sections ===
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 ===
Additional sections that enhance technical articles:
* Detailed technical specifications
* Board revisions and variations
* Upgrade and modification information
* Troubleshooting flowcharts
* Component-level repair guides

== Verification Process ==

=== Technical Review ===
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 ===
Documentation sources should be:
* Verified as authentic when possible
* Cross-checked against multiple sources
* Updated when better documentation becomes available
* Clearly attributed to prevent copyright issues

== Copyright and Fair Use ==

=== Acceptable Use ===
Technical documentation may include:
* Brief excerpts from service manuals for repair purposes
* Component specifications from datasheets
* Circuit descriptions for diagnostic purposes
* Safety warnings from official documentation

=== Copyright Restrictions ===
Content that exceeds fair use includes:
* Complete reproduction of copyrighted manuals
* Substantial portions of proprietary documentation
* Copyrighted training materials in their entirety
* Commercial software or firmware without permission

== Quality Standards ==

=== Minimum Requirements ===
All technical articles must:
* Provide accurate, verifiable information
* Include appropriate safety warnings
* Reference source documentation when available
* Use clear, precise technical language

=== Excellence Indicators ===
High-quality technical articles feature:
* Comprehensive coverage of the hardware
* Multiple verified sources
* Clear illustrations and diagrams
* Detailed troubleshooting procedures
* Active maintenance and updates

== See Also ==
* [[RetroTechCollection:Reliable technical sources]]
* [[RetroTechCollection:Copyright violations]]
* [[RetroTechCollection:Safety requirements]]
* [[RetroTechCollection:Citing sources]]

[[Category:RetroTechCollection policies]]
[[Category:Technical documentation]]