Difference between revisions of "Web/Contributing"
(Some initial comments) |
m (comment on versions) |
||
| Line 8: | Line 8: | ||
Please include useful links about packages, in the format you see already used. Please do not put version numbers of the packages unless you are willing to update those versions, otherwise it will quickly become irrelevant and misleading. |
Please include useful links about packages, in the format you see already used. Please do not put version numbers of the packages unless you are willing to update those versions, otherwise it will quickly become irrelevant and misleading. |
||
| + | |||
| + | If you include code samples and comments about API, then you should mention the associated version that you are talking about, so that the reader can determine the relevance or use of the information. |
||
Revision as of 17:32, 1 October 2010
Below are some suggestions about keeping the web development wiki pages clean and useful. Most of all, they should be valuable and approachable.
Keep pages small
One page should serve one purpose, making linking easier, and pages easier to browse. Remember that users don't mind mindlessly clicking as long as they don't have to think.
Writing about packages
Please include useful links about packages, in the format you see already used. Please do not put version numbers of the packages unless you are willing to update those versions, otherwise it will quickly become irrelevant and misleading.
If you include code samples and comments about API, then you should mention the associated version that you are talking about, so that the reader can determine the relevance or use of the information.