Writing a good wiki example1 - pgRouting/pgrouting GitHub Wiki

Don't use long paragraphs

Long paragraph:

Start with this outline and think about what you need to present, who is your audience, and what they need to know. Expand the outline with additional sub-bullets for the major points you need to cover. Write up each section and add additional sections for details and examples as needed. Have someone to review it and ask questions about what they do not understand. Then update it as appropriate to clarify the questions.

Vs Using a bullet list

  • Start with this outline and think about what you need to present, who is your audience, and what they need to know.
  • Expand the outline with additional sub-bullets for the major points you need to cover.
  • Write up each section and add additional sections for details and examples as needed.
  • Have someone to review it and ask questions about what they do not understand.
  • Then update it as appropriate to clarify the questions.

Links

  • [example 2](Writing a good wiki example2)
  • [back to Writing a good wiki page](Writing a good wiki page)
  • pgRouting Wiki