TechNotesHub.in
Contributor Guide

How to write a great
TechNotesHub note.

One page. Ten minutes. Follow this and your notes will match the voice of the whole library — beginner-first, source-cited, always in plain English.

Become a Contributor See existing series

The 5 principles

Every published note follows these. Non-negotiable.

Beginner-first voice

Write as if the reader is a smart college student in their first month with the topic. No jargon without a plain-English translation. Prefer "container" over "isolated process namespace".

One idea, one note

Long articles hide the good stuff. Break big topics into a short series (3-6 parts). Each note should answer one clear question.

Show, don't tell

Every note has at least one working code block, YAML manifest, ASCII diagram, or table. Reading is passive — copying and running is active.

Source-cited

If you referenced the official docs, link them. If you adapted a PDF/book, attach it. Original wording only — never paste blocks of copyrighted text.

Real-world grounded

Include a "Real-world example" section — where would a real developer meet this? A production story beats 500 words of theory.

The 6-section note template

Copy the layout and just fill it in.

01

Title

Search-friendly. State the outcome, not the tool.
✓ "Deploy a Node.js app to Kubernetes in 10 minutes"
✗ "Kubernetes v1.29 notes"

02

Excerpt (~30 words)

A one-sentence hook. Tells the reader why they should keep reading. Written for the article card + SEO description.

03

Concept in plain English

A short definition, ideally with an analogy. This is what your friend would say over chai.

04

A working example (code / YAML / diagram)

Everyone learns from copy-paste-run. Include a full snippet, not fragments.

05

Real-world example

Where does this actually get used? Even one paragraph is enough.

06

Common gotchas / beginner tips

End with a short bullet list of mistakes freshers make. This is our secret sauce.

Do & Don't

Small edits that make a big difference.

Do
  • Use markdown headings, tables and fenced code blocks.
  • Add an ASCII diagram for anything with a flow.
  • Test every command you paste (yes, actually run it).
  • Prefer 3 short sections over one long one.
  • Link to the official docs at the top or bottom.
  • Tag your article with 2–4 relevant tags.
Don't
  • Copy -paste text from books or PDFs. Rewrite it.
  • Assume prior knowledge without a one-line refresher.
  • Ship a note with no example or diagram.
  • Use screenshots for code — use text so it's copyable.
  • Bury the answer in paragraph 8. Lead with it.
  • Publish without proofreading (paste into Grammarly).

The review flow

What happens between "Publish" and your note appearing on the roadmap.

  1. 1

    Draft in the editor

    Open the Dashboard, hit New, use the multi-draft editor. Drafts autosave every few seconds.

  2. 2

    Add series metadata (if part of a course)

    Fill in series_slug, series_title and series_part so your note joins its friends on the roadmap.

  3. 3

    Attach the source (optional)

    Uploading a PDF? Attach it — logged-in readers can download it directly from the note.

  4. 4

    Publish

    Toggle published: true and hit save. The note is live within a second, appears in category pages and the roadmap.

  5. 5

    Comments moderation

    Reader comments are queued. Admin approves them within a day so signal stays high.

Ready to share what you know?

Every good note helps a fresher land their first job. Yours could be the one someone bookmarks on interview day.

Sign up as a Contributor