Jump to content

RTC:Article wizard/Referencing: Difference between revisions

From RetroTechCollection
No edit summary
No edit summary
 
(One intermediate revision by the same user not shown)
Line 1: Line 1:
<noinclude>{{Pp-template}}
<noinclude>{{Pp-template}}
</noinclude>{{RTC:Article wizard/Content|title=Technical documentation and verifiability |content=Your article '''will be declined''' if the hardware is not '''[[RTC:Technical documentation|documentable]]''', '''[[RTC:Copyright violations|violates copyright]]''', or '''[[Help:Citing sources|lacks proper technical verification]]'''.
</noinclude>{{RTC:Article wizard/Content|title=Technical documentation and verifiability |content=Your article '''will be declined''' if the hardware is not '''[[RetroTechCollection:Technical documentation|documentable]]''', '''[[RetroTechCollection:Copyright violations|violates copyright]]''', or '''[[RetroTechCollection:Citing sources|lacks proper technical verification]]'''.
;Hardware Documentation Requirements:
;Hardware Documentation Requirements:
:The hardware covered in an article must have verifiable technical specifications and repair documentation available through '''[[RTC:Reliable technical sources|reliable technical sources]]'''. These include official service manuals, engineering documents, circuit schematics, component datasheets, and established technical websites with documented repair procedures. Forum posts, social media claims, video descriptions, or undocumented modification guides do not qualify as primary sources.
:The hardware covered in an article must have verifiable technical specifications and repair documentation available through '''[[RetroTechCollection:Reliable technical sources|reliable technical sources]]'''. These include official service manuals, engineering documents, circuit schematics, component datasheets, and established technical websites with documented repair procedures. Forum posts, social media claims, video descriptions, or undocumented modification guides do not qualify as primary sources.
;Technical Accuracy
;Technical Content and Copyright
:Do not '''[[RTC:COPYPASTE|copy-paste]]''' technical specifications or '''[[RTC:Service manual reproduction|reproduce copyrighted service manual content]]'''. Instead, summarize technical information in your own words while maintaining accuracy of critical specifications such as voltages, component values, and safety procedures.
:Technical specifications and service manual excerpts may be '''copied directly''' when properly referenced. Service manuals and datasheets can be uploaded to support articles. However, do not '''[[RetroTechCollection:Service manual reproduction|reproduce entire copyrighted publications]]''' or substantial portions that would constitute copyright infringement. Brief technical excerpts for repair and documentation purposes are acceptable with proper attribution.
;Source Verification
;Source Verification
:*Official service documentation and technical manuals are preferred over community-generated content.
:*Official service documentation and technical manuals are preferred over community-generated content.
:*Manufacturer specifications, datasheets, and engineering documents can verify '''[[RTC:Technical specifications|technical specifications]]''' and '''[[RTC:Safety requirements|safety requirements]]'''.
:*Manufacturer specifications, datasheets, and engineering documents can verify '''[[RetroTechCollection:Technical specifications|technical specifications]]''' and '''[[RetroTechCollection:Safety requirements|safety requirements]]'''.
:*Personal blogs, unverified forum posts, and video tutorials are ''generally not'' acceptable as primary sources.
:*Personal blogs, unverified forum posts, and video tutorials are ''generally not'' acceptable as primary sources.
:To create a technical reference, use <code><nowiki><ref></ref></nowiki></code> as follows:
:While not required, '''strongly consider''' creating technical references using <code><nowiki><ref></ref></nowiki></code> as follows:
::<code>The power supply outputs +5V and ±12V rails.{{xt|&lt;ref&gt;<nowiki>{{cite manual |title=Service Manual |publisher=Apple Computer |year=1984 |pages=23-25}}</nowiki>&lt;/ref&gt;}}</code>
::<code>The power supply outputs +5V and ±12V rails.{{xt|&lt;ref&gt;<nowiki>{{cite manual |title=Service Manual |publisher=Apple Computer |year=1984 |pages=23-25}}</nowiki>&lt;/ref&gt;}}</code>
:'''Safety Documentation:''' All articles covering repair procedures must include appropriate safety warnings with verified sources. High-voltage equipment (CRTs, power supplies) requires specific safety protocols documented in official service materials.
:'''Safety Documentation:''' All articles covering repair procedures should include appropriate safety warnings. High-voltage equipment (CRTs, power supplies) requires specific safety protocols documented in official service materials.
:More details on technical citation standards can be found in our '''[[Help:Technical documentation guidelines|technical documentation guidelines]]'''.
:More details on technical citation standards can be found in our '''[[RetroTechCollection:Technical documentation guidelines|technical documentation guidelines]]'''.
<div style="text-align:center;">
<div style="text-align:center;">
|next_link=RTC:Article wizard/CommonMistakes|next_link_label = Next|}}
|next_link=RTC:Article wizard/CommonMistakes|next_link_label = Next|}}
</div>
</div>

Latest revision as of 16:57, 5 September 2025

RTC Article Wizard
Technical documentation and verifiability
Your article will be declined if the hardware is not documentable, violates copyright, or lacks proper technical verification.
Hardware Documentation Requirements
The hardware covered in an article must have verifiable technical specifications and repair documentation available through reliable technical sources. These include official service manuals, engineering documents, circuit schematics, component datasheets, and established technical websites with documented repair procedures. Forum posts, social media claims, video descriptions, or undocumented modification guides do not qualify as primary sources.
Technical Content and Copyright
Technical specifications and service manual excerpts may be copied directly when properly referenced. Service manuals and datasheets can be uploaded to support articles. However, do not reproduce entire copyrighted publications or substantial portions that would constitute copyright infringement. Brief technical excerpts for repair and documentation purposes are acceptable with proper attribution.
Source Verification
  • Official service documentation and technical manuals are preferred over community-generated content.
  • Manufacturer specifications, datasheets, and engineering documents can verify technical specifications and safety requirements.
  • Personal blogs, unverified forum posts, and video tutorials are generally not acceptable as primary sources.
While not required, strongly consider creating technical references using <ref></ref> as follows:
The power supply outputs +5V and ±12V rails.<ref>{{cite manual |title=Service Manual |publisher=Apple Computer |year=1984 |pages=23-25}}</ref>
Safety Documentation: All articles covering repair procedures should include appropriate safety warnings. High-voltage equipment (CRTs, power supplies) requires specific safety protocols documented in official service materials.
More details on technical citation standards can be found in our technical documentation guidelines.