RepairWiki:RepairGuideHelp: Difference between revisions

From Repair Wiki
(Created page with "Repair Guide pages focus on documenting specific problems and solutions. When creating a new repair guide page, the title '''must first''' include the device it's intended to '''then''' a short description of the problem. Choosing the correct title is vital to avoid confusion and to improve SEO (Search Engine Optimization). Use "Not turning on" instead of "No power" for example. The title should be something that a person would naturally type into Google as their initia...")
(No difference)

Revision as of 17:33, 29 June 2024

Repair Guide pages focus on documenting specific problems and solutions.

When creating a new repair guide page, the title must first include the device it's intended to then a short description of the problem. Choosing the correct title is vital to avoid confusion and to improve SEO (Search Engine Optimization). Use "Not turning on" instead of "No power" for example. The title should be something that a person would naturally type into Google as their initial query when encountering that problem.

After choosing a title and creating the page, you can start filling in the information based on the provided template. Making use of Bullet and Numbered lists is a good idea to help break down the problem into individual steps that are easier for the reader to understand/follow. Try to include as many pictures as possible. When talking about a component, mark it with a number and refer to its corresponding picture, for example: U7001 (Figure 1). Where Figure 1 is the caption to the relevant image.

When done, save the page then click Edit semantics button at the top and fill in the information about this guide. This step is very important to assign your guide to the appropriate device(s) and make it easier to find.

Repair guides are stubs by default! If you believe the guide you wrote has little to no improvements left then you can remove the stub tag either by clicking on it in visual editor and then delete or by removing the {{Stub}} in source editor.

The attributes for repair guide pages are:

  • Affected parts: the parts which the guide is intending to repair/fix. E.g. Motherboard, Display assembly, Speaker, Touch sensor.
  • Equipment needed: input everything you used to repair the problem from tools used to open the device to tools used to replace the broken/faulty parts.
  • Type: choose the type of repair guide
  • Difficulty:
    • Easy: only for part replacement where the parts can be easily obtained and there is little to no risk of breaking the device while trying to replace it
    • Medium: for part replacement if the parts/tools can't be easily obtained and there is mild risk of breaking the device while opening/replacing
    • Hard: anything that includes soldering
    • Specialist: BGA reworking