Page Creation Guidelines

From Control Engineering
Jump to navigation Jump to search

When creating a page, there are a few guidelines to take into account as the knowledge level of the reader is unknown. For this purpose, a proposed layout is given in order to guide content creation to be both accessible and comprehensive. This guideline is not always suitable, however, the purpose of this organizational style is important to consider when authoring any page.

Introduction

The introduction at the top of the page should achieve the following points.

  • What is the content discussed specifically
  • What is the point of the content discussed, why is it useful or why is it interesting
  • Are there recommended prerequesite topics to know before approaching the topic discussed? If so, which?

Basic Explanation

The first section would ideally be the most basic explanation possible for a subject. This is for the people evaluating whether something is relevant to their application, or for the people who just want to implement a controller without all of the derivations. Keep it simple enough that @falcon6280 can understand it.

Explanation of application of the content

The second section should be an explanation of how the content is typically applied. This section will likely have many different subsections with different methods and discussion of best practices. If a subsection is extensive, always consider whether it would be worth breaking it off into its own page and limiting the local explanation to summarization and a link.

A Basic Example

Following the application explanation comes a minimal example of applying the content. This would ideally come from one of a small number of commonly used example systems which the reader would be more likely to recognize. Along with each example should be a code sample written in python, matlab, or any other relevant, commonly used. software.

Advanced Explanation

Now that the basics are done, the more in depth discussion of the content may begin. This section has fewer guidelines as the content can be so varied. Try to keep to the most commonly used notation possible and if uncommonly used notion is present, mention it and link to relevant documentation pages with the first use. Not everyone is a mathematician.

Related Pages

Make a list of related pages and topics. If a page does not exist yet, make a link anyways.

Further Examples

Make a list of examples(on another page) that use the content mentioned. If you use a method in an example page, link back to the method used. Ease of finding content is the key.

References

Remember to cite as much as possible. Also please don't plagiarize.....