JohnBeckett (talk | contribs) (Rework, moving some material to other guidelines.) |
JohnBeckett (talk | contribs) (Add links to policy/help/community.) |
||
Line 1: | Line 1: | ||
{{NavPolicy}} |
{{NavPolicy}} |
||
+ | __NOTOC__ |
||
==Keep it simple== |
==Keep it simple== |
||
Generally, only simple tips are useful. A tip should not explain all details like a reference manual. |
Generally, only simple tips are useful. A tip should not explain all details like a reference manual. |
||
Line 16: | Line 17: | ||
See the [[Vim_Tips_Wiki:Template_guidelines|template guidelines]] for an overview of the templates used for Vim tips. |
See the [[Vim_Tips_Wiki:Template_guidelines|template guidelines]] for an overview of the templates used for Vim tips. |
||
+ | |||
+ | ==See also== |
||
+ | *[[Vim_Tips_Wiki:Policy|Policy introduction]]. |
||
+ | *[[Help:Editing|Help on editing and wiki syntax]]. |
||
+ | *[[Vim_Tips_Wiki:Community_Portal|Community overview, and asking for help]]. |
||
[[Category:Policy]] |
[[Category:Policy]] |
Revision as of 01:25, 3 August 2007
Keep it simple
Generally, only simple tips are useful. A tip should not explain all details like a reference manual.
A tip may deal with a complex topic. However, the tip should merely illustrate the concepts and provide an example. It should not cover all possibilities.
If a tip is only useful in an obsolete version of Vim, the tip should be deleted. Vim version 7.0 was released in May 2006 and the best tip for people using older versions is please update!
See deleting a tip for information about deleting a tip, or marking a tip as Deprecated, or effectively hiding a tip.
Merge similar tips
Tips which cover the same material should be merged. You can simply flag duplicate tips to notify others that the tips need to be merged. Or, you can merge the material into one tip. See the merge guidelines.
Useful templates
Several templates are available to simplify and standardize common tasks. For example, you could use the Help template by entering {{help|pattern}} into a tip. The result looks like this :help pattern.
See the template guidelines for an overview of the templates used for Vim tips.