Writing guide (this article) is a guide to writing articles in this wiki.

Every article should preferably start with a main section followed by a few paragraphs. The first paragraph should preferably start with the name of the article in bold (just as it did in this article) followed by a few sentences that further describe the concept.

Paragraphs should describe one main idea in 3-6 sentences. Preferably (though not necessarily so) this idea is better described by an artifact just below the paragraph e.g. a code block, equation or an image. A section should contain 2-5 paragraphs. If there are too many paragraphs, it's fine to open subsections but then they have to contain 2-5 paragraph as well.

Sections should have a certain flavor. For example, if a section is titled “List of concepts related to X” it should only contain a list and no additional description. Similarily, if a section is titled “C++ code illustrating X” it should only contain a code block and preferably no prose. Any additional description can be added in the code comments. Same goes for equations. A section like “Equations of X” or “” should only contain LaTeX $$ ... $$ and little description. It should only

The first section should preferably always start with a paragraph that starts with the name of the article in bold followed by a short description (two-three sentences) of what the concept is. The subsequent paragraphs should expand the concept in the most nautral way.

A code block is a larger piece of code that. Preferably all code blocks should be self-contained MVEs (minimum viable examples). At the top there should be a comment block on how to compile and run the code.

// Compile:     g++ main.c -o main
// Run:         ./main
// Description: echo "Hello world!"
 
#include <stdio.h>
 
int main()
{
    printf("Hello world!");
    return 0;
}