Style guide

Attribution

Most of the time, I say "by CHANNEL_NAME," such as "by Khan Academy," but in the case of "by Maths Videos - by jayates," I have opted for "by jayates" instead.

Lesson blocks (<div class="block lesson">)

Watch these CHANNEL_NAME videos:

OR

Watch these videos by CHANNEL_NAME:

Prefer the former. For example:

Watch these Khan Academy videos:

But sometimes it's less clumsy to use the latter. For example:

Watch these Micro Visual Proofs videos:

is more clumsy than

Watch these videos by Micro Visual Proofs:


Writing in general

Titles will follow the Wikipedia style. That is, lowercase letters except for the first, which is uppercase.

Don't put words that end in the same sounds side by side. Instead of "Therefore, before attempting..." I would prefer "Thus, before attempting..."

Titles should be italicized. I personally find bold text distracting, so I don't like to use it in my writing. If a punctuation follows a title, I pretend the title is actually in quotes. This would mean, for example, periods and commas go inside quotes.

If a sentence ends with an ellipses, I don't add a period, but if the sentence is a question I will add a question mark. Ellipses can end a sentence only if they occur in a math expression. Generally, I want you to use "and so on," "and so forth," or "etc."


Writing math lessons

For topics that are not covered in the same year, start by reviewing the prerequisite concepts. For example, when teaching the formula for the diagonal length of a right rectangular prism, start by reviewing the formula for the diagonal length of a rectangle.


Math terminology

As stated in this video, some authors say increasing and non-decreasing, while others use strictly increasing and increasing. We choose strictly increasing and increasing, only because I'd rather not replace all references to those terms right now, and I'm not even sure which set of terms is generally preferred.

\(\arctan,\) \(atan,\) or \(\tan^{-1}?\) I have no preference. I have gone with \(\tan^{-1}\) because it's the most common, based on my experience.

I prefer to say "sketching" instead of "approximating" when the topic involves drawing. I've seen both used, which is important to remember when searching for videos.


MathJax

When typesetting integrals, put \, before dx, as in

$$\displaystyle \int_a^b c\,dx$$ This matches the style of "Paul's Online Notes."

Do \, for lists:

\(x = 3,\,4,\,5\)

I much prefer this:

\(x = 3,\,\left(\dfrac{1}{2} + \dfrac{\sqrt{5}}{2}\right),\,\left(\dfrac{1}{2} - \dfrac{\sqrt{5}}{2}\right)\)

to this:

\(x = 3,\,\dfrac{1}{2} + \dfrac{\sqrt{5}}{2},\,\dfrac{1}{2} - \dfrac{\sqrt{5}}{2}\)

for elements with multiple terms. Same goes for set builder notation:

$$\left\{3,\,\left(\dfrac{1}{2} + \dfrac{\sqrt{5}}{2}\right),\,\left(\dfrac{1}{2} - \dfrac{\sqrt{5}}{2}\right)\right\}$$

instead of

$$\left\{3,\,\dfrac{1}{2} + \dfrac{\sqrt{5}}{2},\,\dfrac{1}{2} - \dfrac{\sqrt{5}}{2}\right\}$$

Commmas are small, which makes it difficult to focus on an expression.


HTML

Entity references should be ASCII. For example, &copy; not ©


I agree with all of this except their take on entity references.