Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

first draft of guide #133

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

first draft of guide #133

wants to merge 1 commit into from

Conversation

Titre123
Copy link

/claim #50

Writer's Checklist

Writing Structure

  • Use short sentences and paragraphs, and include bucket brigades.
  • Include more than two descriptive H2 headings to organize content.
  • Capitalize headings according to the AP Stylebook
    (use this tool)
  • Include an introduction with at least two paragraphs before the first H2
    section.
  • Use appropriate formatting (bold, italic, underline), notes, quotes,
    TLDRs, and key points.
  • Incorporate code elements and Markdown format where appropriate.
  • Ensure at least one visual element per “screen” of the article
    (screenshots, diagrams, tables, graphs, lists, sidenotes, blockquotes).

Fact-Checking

  • Verify all facts and data points included in the article.

Asset Management

  • Save images in the /assets folder.
  • Follow naming conventions:
    YYYYMMDD_title_of_the_article_IMG_NAME_NO.png.
  • (Optional) Create a GitHub repo for the code referenced in the article and
    share it.
  • (Optional) Include a link to this Loom video in the PR comments.

Interlinking

Glossary/Definitions

  • Create new definition in /defitnitions folder.

Review and Edit

  • Ensure articles address the needs of the target audience and their search
    intent.
  • Read the article out loud to catch any awkward phrasing.
  • Run the draft through Grammarly or a similar
    grammar tool.
  • Double-check adherence to the style guide and repository guidelines.
  • Use the name of the article for the title of the PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant