Technical-writing-mentorship-program / Technicalwritingcourse

This repo contains resources to help you kick start your technical writing career.
https://technicalwritingmp.com/
MIT License
43 stars 15 forks source link

Building GraphQL APIs: A Step-by-Step Guide #129

Open susanodii opened 2 weeks ago

susanodii commented 2 weeks ago

Issue Template for Technical Writing Articles

Article Title: Building GraphQL APIs: A Step-by-Step Guide

Category: Backend Development

Outline Submission Instructions: Your outline should use the following structure:

  1. Introduction:

    • Brief introduction to the topic.
    • Why is this topic important?
  2. Main Sections:

    • List the main sections and subsections of the article.
    • Provide a brief description of what each section will cover.
  3. Conclusion:

    • Summarize the main points.
    • Provide any final thoughts or recommendations.

Submission Process:

  1. Submit Outline:

    • Create a document or use the comment section to submit your article outline.
    • Ensure your outline follows the structure mentioned above.
  2. Review Process:

    • The outline will be reviewed by a project maintainer.
    • Feedback will be provided within a few days.
    • Make necessary revisions based on the feedback.
  3. Approval:

    • Once the outline is approved, you can start writing the full article.
    • Follow the project guidelines for article writing.

Article Writing Guidelines:

Deadline:

NOTE: Before picking up an article, make sure you've checked out the CONTRIBUTING.md guide