Guidelines
From UBot Studio
(Difference between revisions)
| Line 1: | Line 1: | ||
All entries explaining commands or functions should contain subsections: | All entries explaining commands or functions should contain subsections: | ||
| − | # A description of the command | + | # A description of the command. |
| − | # An examples use of the command | + | Inside the description, the group where the command or function belongs (ie, "[[Action Commands]]") should be described and linked to. |
| + | |||
| + | # An examples use of the command. | ||
| + | |||
| + | Examples of the command should include both screenshots of the node view of the code example, and the correct code view syntax as well. | ||
| + | |||
| + | # If possible, external uses of the command. | ||
| + | |||
| + | Suggestions for this would be forum posts. | ||
| + | |||
| + | |||
| + | == Where to use links == | ||
| + | |||
| + | Links should be made to any concept or idea (ie, [[loops]]) that has a page, and any concept or idea that does not already exist as a page should have a page created. | ||
Revision as of 00:53, 10 October 2012
All entries explaining commands or functions should contain subsections:
- A description of the command.
Inside the description, the group where the command or function belongs (ie, "Action Commands") should be described and linked to.
- An examples use of the command.
Examples of the command should include both screenshots of the node view of the code example, and the correct code view syntax as well.
- If possible, external uses of the command.
Suggestions for this would be forum posts.
Where to use links
Links should be made to any concept or idea (ie, loops) that has a page, and any concept or idea that does not already exist as a page should have a page created.
