Skip to content

Instantly share code, notes, and snippets.

@npentrel

npentrel/Writing Template.md

Last active August 9, 2023 09:16
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save npentrel/eab4acd204d6e28f70a39417e6f1ffae to your computer and use it in GitHub Desktop.
Save npentrel/eab4acd204d6e28f70a39417e6f1ffae to your computer and use it in GitHub Desktop.
Download ZIP
The hardest part about writing is starting with an empty page - so don’t do that. Use this template instead and add bullet points. Then turn those points into writing!
Raw
Writing Template.md
  • Introduction
    • What problem/topic is being addressed?
    • What is the structure of the post?
    • Where is the code?
  • Prerequisites
    • Technical setup
    • Knowledge
  • Setting up
    • Document your hardware setup
    • Document how to configure your hardware
    • Obtain API keys, the code and everything else needed to get started
  • Content/Coding
    • Content/Code broken down into section that show different steps/topics
  • Conclusion
    • Summarize learnings
    • Link to full solution (if applicable)
    • Call to action (connect with you, explore/read further...)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment