We welcome contributions to this project.
You can report errors, send suggestions, ask questions. Here is how you can contact us.
You can also add new topics or update existing content by following these steps:
Do include a table of contents. A table of contents tells the reader what to expect, such as how long the article is and what content is covered. It also serves as a reference that makes it easier to jump around from section to section. In our case, we only show the table of contents for mobile users and for printing as Markbind already provides a navigation panel on the right side of every article. Feel free to refer to this pull request to see how to implement this behavior.
Do use Title Case for headings. Using title case for headings gives articles a more polished, professional look that is more pleasing to the eye. If you are unfamiliar with the rules of title casing, you may refer to the following website or use online title case converters such as the one found here.
It is not a normal textbook. It’s a collection of articles, each containing a curated list of tried-and-tested learning resources, organized in a meaningful sequence, with commentary.
The suggested structure for an Article
Do not assume a lot of prior knowledge on the part of the reader. The less prior knowledge you assume, the wider your reader base becomes. The article is aimed at typical SE students, but not necessarily SE students in your school. Just because it is covered in a core module in your school does not mean it will be known to every reader.
Do not re-invent the wheel by writing a lot of original content. Instead, give a brief high-level view and point to other existing resources that you recommend the reader to use. original source.
Stay an independent observer. When writing about a tool/technique that has competing alternatives, the article will have more credibility if you write it from the point of view of an independent observer. For example, avoid unsubstantiated marketing claims e.g., X is the best tool for doing Y. Instead, you can cite quotes by other credible sources or from the tool/technique itself. See the two examples below:
Tool X claims to have the fastest performance [source].
Tool X's website has the following to say about its performance:
Tool X has the best performance of its class. ...
Prefer visuals rather than long paragraphs.
Some of the existing articles might not follow the above guidelines (the guidelines emerged over time). Feel free to revise existing content to fit the guidelines.