Wednesday Playbook
Our Services
  • Welcome to our Playbook
  • What we do
    • Our Services
      • Catalyse - For companies looking for staff augmentation services
      • Launch - Startups and Early Stage Companies
      • Control - Fast-paced tight-deadline projects with moonshot ROI potential
      • Amplify - Scaleups and Hyper-Growth Companies
      • Do's and don'ts
      • Ceremonies
    • Our Partner Programs
      • Agency Partner Program
      • Advisor/Consultant Partner Program
      • Investor Partner Program
      • Developer Tooling Partner Program
  • Employee Handbook
    • How We Work
      • Our Values
      • Our Dream Team
      • Our Leave Policy
      • Out of Office
      • Communication
      • Security Practices
      • Hiring Philosophy
    • Employment Policies
      • Equal Opportunity Employment
      • At-Will Employment Policy
      • Code of Conduct
      • Employee Privacy
      • Compensation
      • Performance Appraisal Policy
        • Timeline for each appraisal cycle
        • Guidelines for Self, Manager, Peer & Colleague Reviews
    • Starting at Wednesday
      • Your first day
        • Onboarding Checklist
      • Becoming a permanent employee
      • Getting Paid
      • Dress Code
      • Work Hours
    • Benefits and Perks
      • Holiday List
      • Paid Time Off
      • Group Health Insurance
      • Conferences
      • Hardware & Software Licenses
  • Engineering Playbook
    • Introduction to Our Engineering Playbook
    • System Architecture & Design
      • Templates
    • Release Engineering
      • Git-flow
      • Code reviews
      • Commit Messages
      • Pull requests
      • Continuous Integration and Delivery
    • Careers in Engineering
      • Hiring Engineers
      • Career Growth
  • DESIGN PLAYBOOK
    • Introduction to Our Design Playbook
    • Who we are
      • Our Journey
    • Why Us
      • Our Values As Designers
    • Careers in Product Design
      • Hiring Designers
  • Project Management Playbook
    • Introduction to Our Project Management Playbook
    • General Guidelines
      • Checklists
        • Internal Checklist
        • Customer Onboarding Checklist
    • Our Approach
      • Agile Ceremonies
        • Sprint Planning
        • Standups
        • Retrospectives & Demos
      • Stakeholder Management
        • Documentation
      • Team Management
    • Careers in Project Management
      • Career Growth
  • Communications
    • Introduction to Our Communications Playbook
    • Content
      • Channels
      • Process
        • Articles
          • Article Structure
            • Introduction Section
            • Instruction Sections
            • Getting Started Section
            • Theory Section
            • Reference Sections
            • "Where to go from here" section
          • Choose your topic
          • Write your outline
            • Research the topic
            • Create your article outline
          • Sample project
            • Follow the four commandments
            • Create a starter project
          • First draft
            • Think of the reader as a beginnner
            • Stay in limit
            • Make it scannable
            • Explain Code
          • Polish your draft
            • Use Hemingway
            • Review as a reader
    • Brand Assets
      • Wednesday
      • The Wednesday University
      • The Wednesday Show
  • Legal Templates
    • Client Contracts
      • Fixed Cost
        • Master Services Agreement for Fixed Cost
        • Statement of Work for Fixed Cost Projects
      • Time and Material
        • Master Services Agreement for T&M
        • Statement Of Work for T&M Projects
    • Personnel Contracts
      • Internship Offer & Intent to Hire
        • Internship Offer Template
        • Annexure 1 - List of Documents for Interns
        • Acknowledgment of Receipt of Playbook for Interns
        • Letter of Intent to Hire
      • Offer cum Appointment Letter for full-time personnel
        • Offer Cum Acceptance Letter Template
        • Annexure 1 - List of Documents for Personnel
        • Acknowledgment of Receipt of Playbook for Personnel
      • Contractor Agreement
        • Contractor Agreement Template
        • Annexure A
  • Elsewhere
    • Our Products
    • The Wednesday Show
    • Wednesday University
Powered by GitBook
On this page

Was this helpful?

Edit on Git
  1. Communications
  2. Content
  3. Process
  4. Articles
  5. Article Structure

Reference Sections

An overview of what the Reference section should consist of within each article. This should be kept in mind when creating content for Wednesday.

By nature, an article shows a reader how to use an API or technology in a sample project, to solve a single use case.

You want readers to actually apply the API or technology in their own projects, to solve any use case.

To do this, it’s important to periodically have reference sections in your article to explain other things that the reader can do outside of the scope of your single-use case.

For example, there is a database library in Android called Room, that has a set of operations.

Imagine you wanted to create an article to cover Room operations actions. You have a few options:

  • Try to cover all possible operations [BAD]: There are a lot of operations, so that would be quite difficult, and would make for a long or boring article.

  • Cover the most useful operations, and ignore the rest [BAD]: You could choose a few operations to cover and ignore the rest. This isn’t ideal, as you wouldn’t really help the reader: you’d be leaving them to discover and learn them on their own, without any assistance.

  • Cover the most useful operations, and add a reference section [GOOD]: This leads us to the best option. Choose a few operations to cover, then add a short reference section to show the reader what other operations are available, and where they can learn more about them.

When developing your article, ask yourself “what does the reader need to know about this API or technology, outside of the scope of what I will show them with my sample project?”

Then create reference sections for those.

PreviousTheory SectionNext"Where to go from here" section

Last updated 2 years ago

Was this helpful?