Technical Content Creation
Vocabulary for engineers and developer advocates creating technical tutorials, talks, screencasts, and blog posts that educate and build community.
- Tutorial /tjuːˈtɔːriəl/
A structured, step-by-step piece of technical content that teaches a reader how to accomplish a specific task — prioritising learning by doing, with working code examples and clear success criteria at each stage.
"Our 'Deploy a Node.js app to Kubernetes in 20 minutes' tutorial has a 73% completion rate — it succeeds because each step produces a visible, testable result, so readers can verify they're on track before proceeding."
- Walkthrough /ˈwɔːkθruː/
A narrative-style technical guide that leads the reader through a process or codebase — focusing on explanation and context rather than task completion, often used for code reviews, architecture explanations, or feature tours.
"The PR walkthrough I published explaining the new caching architecture received more positive feedback than the feature announcement — developers appreciated the narrative explaining why each design decision was made, not just what changed."
- Diataxis Framework /daɪəˈtæksɪs ˈfreɪmwɜːk/
A documentation framework by Daniele Procida that organises technical content into four types based on learning mode and knowledge type: tutorials (learning-oriented), how-to guides (task-oriented), explanations (understanding-oriented), and reference (information-oriented).
"Adopting the Diataxis framework transformed our docs site — we stopped mixing tutorials with reference material in the same pages. Separating learning content from lookup content reduced the average time to find an answer from 4.2 minutes to 1.8 minutes in user testing."
- CFP (Call for Proposals) /siː ef piː/
A public invitation from a conference or event for speakers to submit proposals for talks, workshops, or sessions — typically requiring a title, abstract, and speaker biography for review by a programme committee.
"I submitted three CFPs this quarter: two were rejected and one was accepted at a 1,200-attendee DevOps conference. The accepted abstract focused on a concrete problem and specific outcome — the rejected ones were too abstract and lacked a clear takeaway for the audience."
- Talk Abstract /tɔːk ˈæbstrækt/
A 150–300 word summary of a conference talk that describes the problem addressed, the approach taken, and the key takeaways — used in CFP submissions and published in conference programmes to help attendees choose sessions.
"I rewrote my talk abstract after getting two CFP rejections — the new version opens with a relatable problem statement, names the specific audience (senior engineers managing distributed systems), and ends with three concrete takeaways. Acceptance rate improved from 0% to 40%."
- Screencast /ˈskriːnkɑːst/
A video recording of a screen with narration — used to demonstrate software, walk through code, or teach technical workflows. Combines the immediacy of video with the precision of code, making complex processes easier to follow than text alone.
"We replaced our written deployment tutorial with a 12-minute screencast — support tickets related to deployment setup dropped 61% in the following month. The screencast shows exactly what the terminal output should look like at each step, eliminating ambiguity."
- Engineering Blog /ˌendʒɪˈnɪərɪŋ blɒɡ/
A publication by an engineering team that shares technical decisions, lessons learned, architecture deep-dives, and case studies — building technical credibility, supporting recruitment, and contributing to the developer community.
"Our engineering blog post about how we reduced p99 latency from 800ms to 120ms received 47,000 views and generated 14 qualified engineering candidates who cited the post in their cover letters — a single well-written post that served both marketing and recruitment goals."
- Learning Objective /ˈlɜːnɪŋ əbˈdʒektɪv/
A clear, measurable statement of what a reader or attendee will be able to do after consuming a piece of technical content — guides the content structure and helps the audience self-select appropriately.
"I always write learning objectives before drafting a tutorial: 'After completing this guide, you will be able to configure mTLS between two services, verify the handshake with openssl, and debug certificate errors in the logs.' The objectives keep the content focused and set accurate expectations."
- Prerequisites Section /ˌpriːrɪˈkwɪzɪts ˈsekʃən/
A section at the beginning of a tutorial or guide that lists the knowledge, tools, and environment setup required before starting — reducing reader frustration by setting clear expectations about what is needed to successfully follow the content.
"Adding an explicit prerequisites section to our Kubernetes tutorial reduced the volume of 'I'm stuck at step 3' support messages by 44% — most were caused by readers who lacked a configured kubectl context, which the prerequisites section now explicitly checks."
- Technical SEO /ˈteknɪkəl es iː əʊ/
Search engine optimisation practices specific to technical content — including keyword research for developer queries, structured headings for crawlability, code block formatting, canonical URLs, and page speed optimisation to maximise organic discovery of technical articles.
"Technical SEO work on our docs site — adding structured headings, targeting long-tail queries like 'how to configure JWT refresh tokens in Express', and improving page load time — grew organic search traffic by 340% in six months without increasing the content publication rate."
- Search Intent /sɜːtʃ ɪnˈtent/
The underlying goal or need a developer has when entering a search query — informational (understand a concept), navigational (find a specific resource), or transactional (find code to copy). Content that matches search intent ranks higher and converts better.
"We analysed the search intent behind 'Kubernetes resource limits' — most searchers wanted a how-to guide, not a conceptual explanation. Rewriting the page as a task-oriented guide with copy-paste YAML examples doubled time-on-page and pushed it from position 14 to position 3."
- Content Funnel /ˈkɒntent ˈfʌnəl/
A framework for mapping technical content to stages of the developer journey — awareness (blog posts, conference talks), consideration (deep-dive tutorials, comparison guides), and decision (quickstarts, migration guides) — ensuring content exists to support developers at every stage.
"Our content funnel analysis revealed a gap at the consideration stage — we had awareness content (blog posts) and decision content (quickstarts) but nothing helping developers evaluate whether our API was right for their use case. We published three comparison guides and saw 30-day trial conversion improve by 22%."
Quick Quiz — Technical Content Creation
Test yourself on these 12 terms. You'll answer 10 multiple-choice questions — each shows a term, you pick the correct definition.
What does this term mean?