Tipps for creating content in Q.wiki

Modified on Thu, 28 Apr 2022 at 03:02 PM

General tips for writing in Q.wiki

  • Write down information in bullet points, avoid continuous text.
  • Be brief, but describe details.
  • Contribute experience.
  • Upload and link forms and templates to related pages.
  • Actively formulate process steps; e.g., "prepare proposal", not "prepare proposal".
  • Attach files only if they are images, templates, or documents.
  • Host videos externally and link them in Q.wiki.


Tips for designing a process description

  • Use "process description" template.
  • Describe process steps in a table in meaningful bullet points (3-5 words).
  • Expand process steps with details, personal knowledge, and aids to better understanding in bullet points and using bullets.
  • Describe process steps in sufficient detail to allow the responsible person to perform it smoothly.
    • If there are problems with a process step, add to it immediately.
  • If more extensive help is required for a process step, describe it on a separate page and link it to the corresponding process step.
  • A responsible person must be assigned to each process step. Information about persons involved and to be informed is optional.
    • Responsible persons are only named as roles.
  • Each process step has only one responsible person.
  • List all documents required for the execution of the process step in the table.
  • Link documents that are already available in Q.wiki. Documents that are not yet available in Q.wiki should be uploaded first and then linked.
  • Note and link predecessor of the current process in the first row of the table.
  • Name and link successor of the current process in the last row of the table.
  • Once all process steps are listed in the table, visualize the process in a swim lane for a better overview.
    • Each person responsible for a process is listed in a swim lane.
    • In the process visualization, list the process steps without additional information.
    • The boxes in the flowchart tool deliberately allow only a certain number of letters to force short and concise formulations.
    • If there are upstream or downstream processes, visualize and link them as process steps.



Tips for designing a work instruction

  • Use the "work instruction" template.
  • Describe work steps in a table in meaningful bullet points (3-5 words).
  • Expand work steps with details, personal knowledge and aids to better understanding in bullet points and using bullet points.
  • Add screenshots to clarify work steps.
  • Describe work steps in enough detail to allow the person responsible to perform it smoothly.
  • If there are problems with a work step, add to it immediately.
  • If extensive help is required for a work step, describe it on a separate page and link it to the corresponding work step.
  • List all documents required for the execution of the work step in the table.
  • Link documents that are already available in Q.wiki. Documents that are not yet available in Q.wiki should first be uploaded and then linked.



Translated with www.DeepL.com/Translator (free version)


Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select atleast one of the reasons
CAPTCHA verification is required.

Feedback sent

We appreciate your effort and will try to fix the article