LQWiki:Do's and Dont's

From LQWiki
Jump to navigation Jump to search

Do:

  • Provide basic descriptive and historical information about the application.
  • Add notes or in-depth commentary on usage/common problems/tips.
  • Include a concise list of important and distinctive features that will help a potential user decide whether a particular application will meet his or her needs.
  • Critically process information you include.
  • Link to official project pages and notable community resources.

Don't:

  • Hesitate to add what you know, especially to a stub; any information is better than no or incorrect information.
  • Simply duplicate the reference manual or uncritically include the project "About" page.
  • Clutter the pages with platitudes, personal experience, opinion, or preference.
  • Try and list every application in the world. Generally stick to those that are popular or distinctive, and stable or actively maintained/developed.