Site Tools


writing-guide

**This is an old revision of the document!**

Table of Contents

Writing guide

Every article should preferably start with a main section followed by a few paragraphs.

Sections

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 like what the list is for. 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. For sections “Matrix representation”. 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.

Code block

A code block is a larger piece of code that

// Compile: g++ main.c -o main
// Run:     ./main
 
#include <stdio.h>
 
int main()
{
    printf("Hello world!");
    return 0;
}
writing-guide.1779715622.txt.gz · Last modified: by Ivan Janevski