How To Articles

Beatrice

English Literature

Write clear, instructional articles for any topic. Find writers who can create succinct and concise numbered steps and instructional articles that meet industry standards on relevant subject matter from software tutorials to user manuals; to develop, organize and format everything from technical instructions in How to- articles to operating and safe work procedures for workplaces. Find How To Articles WFH freelancers on January 21, 2025 who work remotely. Read less

Board & chat Inside your order

Find writers who can produce balanced, accurate copy to a

Article Writing

Find the right tone for internet readers with well-researched content

Blog Writing

Get your article into shape with experienced editors.

Article Editing

News Writing

Hire English grads and journalists online who know how to

Journalism

Find resources to write and edit material destined to be

Journalistic Writing

Find freelance journalists who know how to research, write and

Investigative Reporting

Tell a compelling story with your article that builds on

Feature Writing

Graduates

Verified

Keep exploring

Wikipedia How To Articles Courses

Top Frequently Asked Questions

What to Know

How to write guides and instructions?

Writing "how-to" guides that are both informative and engaging involves a structured approach, combining practical tips from professionals with thorough research. Here's how to go about it:

== Structure of a How-to Guide: ==

Title:
Clear and Specific: Use keywords that describe the task, e.g., "How to Write SEO-Friendly Blog Posts."
Engaging: Incorporate numbers or promises of results, like "5 Steps to Perfect Your Pitch."

Introduction:
Brief Overview: Explain what the reader will learn and why it's beneficial or important.
Engage with a Hook: Start with a question, a surprising fact, or a common problem to grab attention.

Materials or Prerequisites:
List any tools, materials, or knowledge the reader needs before beginning.

Step-by-Step Instructions:
Numbered Steps: Each step should be clear and actionable.
Subheadings for Each Step: Makes the guide easy to navigate.
Actionable Language: Use imperative verbs ("Do this," "Start by...").

Tips and Variations:
Professional Tips: Include insights or shortcuts from experts in the field.
Variations: Suggest alternative methods or how to adapt the guide for different scenarios.

Visual Aids:
Images, Diagrams, or Videos: Visuals can clarify complex steps or show the process.

Troubleshooting or Common Mistakes:
Address potential pitfalls or common errors and how to fix or avoid them.

Conclusion:
Summarize Key Points: Reinforce the main actions or takeaways.

Call to Action: Encourage the reader to try the guide or share their results.

References:
List any sources or professionals whose methods or advice you've included.

== Content Writing and Research: ==

Research:
Use Reliable Sources: Academic articles, books, interviews with professionals, or reputable websites can offer valuable insights. For instance, "8 Steps To Help You Create a How-To Guide" by Indeed.com provides a structured approach to guide creation.

Interview Experts: Reach out to industry professionals for specific tips or unique angles. Document their credentials for credibility.

Writing:
Clear Language: Avoid jargon unless your audience is specialized.
Audience Awareness: Tailor the complexity and language to your target demographic.
Engagement: Use anecdotes or real-world examples where applicable to illustrate points.

Bias-Free Presentation:
Objective Tone: Keep personal opinions out of instructional content unless clearly labeled as such.
Balanced Information: If there are multiple ways to do something, present them all without favoring one unless it's clearly superior based on evidence.
Data Representation: When presenting data or statistics, ensure they are from neutral sources, and present them in a way that doesn't skew interpretation (e.g., using clear, unbiased charts).

How to Present Instructional Guides:
Consistency in Format: Maintain a consistent format for all guides to build reader familiarity.
Accessibility: Ensure instructions are easy to follow for all skill levels:
Beginner: Explain terms and concepts fully.
Intermediate: Offer more in-depth explanations or alternate methods.
Advanced: Include complex tips or optimizations.
Visual Learning: Use visuals not just for decoration but to aid understanding, following the advice from "Basics of Instructional Writing" by ASCENT, which suggests enhancing instructions with graphical references.
Feedback Loop: Allow for user feedback or questions, which not only helps improve future guides but also ensures the content remains unbiased by addressing different user experiences.

Ethical Considerations:
Credit Sources: Always attribute information or methods to their original creators.
Avoid Promotion: Keep the guide focused on instruction rather than promoting products or services unless clearly disclosed as sponsored content.

Proofreading and Testing:
Accuracy: Fact-check all information.
Usability: Test the guide yourself or with a small group to ensure steps are clear and effective.

References for Further Learning:
Indeed.com for steps on crafting how-to guides.
ASCENT for practical guidelines on instructional writing.
WikiHow for examples on structuring how-to articles effectively.

By following this structure, incorporating sourced professional insights, and maintaining an unbiased approach, you can create how-to guides that are both educational and trustworthy.

How to write good documentation?

Writing effective documentation is crucial for ensuring that users, developers, or any stakeholders can understand, use, or contribute to a project or product. Here's how to approach it with tips, lessons from professionals, and examples of structure:

Structuring Documentation:

Title and Introduction:
Title: Should be clear and descriptive, e.g., "API Documentation for XYZ Service."
Introduction: Briefly outline what the documentation covers, its purpose, and who it's for.

Example:
Title: User Guide for WidgetMaker 3.0
Introduction: This guide provides step-by-step instructions on how to use WidgetMaker 3.0 to create and manage widgets for your application.
Table of Contents:
An organized list of sections, making it easy for users to navigate.

Example:
Introduction
Getting Started
Basic Operations
Advanced Features
Troubleshooting
FAQs
Getting Started or Installation:
Instructions on how to begin using the product or service, including setup or installation.

Example:
Getting Started:
Download the WidgetMaker app from [link to download].
Install following the on-screen instructions for your OS.
Open WidgetMaker and sign in or create a new account.
Main Content:
Conceptual Information: Explain concepts or background necessary for understanding the product.
Task-oriented Sections: Group tasks by functionality or user role.
Reference Material: Detailed descriptions of functions, APIs, etc.

Example:
Creating a Widget:
Click on "New Widget" in the dashboard.
Fill out the widget properties form.
Click "Save" to create the widget.
Tutorials or How-Tos:
Detailed walkthroughs for common or complex tasks.

Example:
Tutorial: Custom Widget Design
Step 1: Choose a template from the gallery.
Step 2: Modify colors and layout using the design tools.
Troubleshooting or FAQs:
Address common issues or questions users might have.

Example:
FAQ:
Q: How do I reset my password?
A: Click on "Forgot Password" on the login page and follow the instructions.
Contributing Guidelines (for open-source projects):
How developers can contribute to the project.

Example:
Contributing:
Fork the repository on GitHub.
Make your changes and submit a pull request.
Appendices, Glossary, or Additional Resources:
Supplementary information or references.

Example:
Glossary:
Widget: A small application or tool within the main software.
Version History or Changelog:
Document changes, updates, or fixes across versions.

Example:
Version 3.1:
Fixed bug in widget configuration saving.
Added support for custom themes.
Contact Information or Support:
How to get help or provide feedback.

Example:
Support: Email us at support@widgetmaker.com (mailto:support@widgetmaker.com) or visit our support forum.

Tips and Lessons from Sourced Professionals:

Keep it Simple and Clear: According to "How to Write Good Documentation" by Lari Maza on Medium, documentation should avoid overly specific details that can change, focusing instead on processes or where to find dynamic information.

Audience Awareness: Swimm's "10 Best Practices For Writing Documentation" emphasizes understanding your audience to tailor documentation to their technical level or role.

Use Visuals: The guide from "How to Create Technical Documentation with Examples" on Document360 highlights the use of screenshots, gifs, or diagrams to clarify complex instructions.

Consistency: Microsoft's "Reference documentation - Microsoft Style Guide" suggests maintaining consistency in terminology, headings, and structure to help users navigate documentation quickly.

Maintainability: Swimm also advises on keeping documentation close to the source code for easier updates, using tools that link documentation directly with code changes.

Version Agnostic: "Documentation principles — Write the Docs" recommends writing content that's as version-agnostic as possible to reduce maintenance.

Feedback Loop: From "Project Management Lessons Learned" by Smartsheet, incorporating feedback from users or team members can improve documentation quality over time.

Research and Content Writing:
Research: Use interviews with subject matter experts, reference existing documentation from similar projects, and review user feedback to understand what's needed.

Content Writing:
Language: Use clear, concise language. Avoid jargon unless your audience is specialized.
Structure: Follow a logical flow, often from simple to complex, or from setup to advanced usage.
Active Voice: Use active voice for instructions to make them more direct and engaging.

Presenting Information:
Bias-Free: Ensure all information is factual and not tailored to promote one viewpoint over another unless it's a known best practice or standard.

Accessibility: Test your documentation for readability, usability, and accessibility, ensuring it's helpful for all users regardless of their experience level.

Cite Sources: When using advice or best practices from professionals, cite them or link to their resources for credibility and further reading.

By integrating these tips and structuring your documentation appropriately, you'll create resources that are both usable and valuable to their intended audience.

#JaneIsPowerful

Find people to hire.

Job done or your money back.

Continue with X

Continue with Google

Continue with email

Browse Categories