daytonaio / content

Daytona Content Programme for Technical Writers
https://www.daytona.io/dotfiles/
Other
67 stars 39 forks source link

Streamlining Data Science Workflows with Cookiecutter and Daytona #106

Open bellatrick opened 1 month ago

bellatrick commented 1 month ago

/claim #52 Loom Video

Writer's Checklist

Writing Structure

Fact-Checking

Asset Management

Interlinking

Glossary/Definitions

Review and Edit

algora-pbc[bot] commented 1 month ago

💵 To receive payouts, sign up on Algora, link your Github account and connect with Stripe.

bellatrick commented 1 month ago

/claim #52 Loom Video

Writer's Checklist

Writing Structure

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

Fact-Checking

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

Asset Management

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

Interlinking

Glossary/Definitions

  • [x] Create new definition in /defitnitions folder.

Review and Edit

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

Hi @nkkko, this PR is ready for review