Upgrade to Pro — share decks privately, control downloads, hide ads and more …

Technical Articles Writing

Technical Articles Writing

Tips of how to get started with technical articles writings, like: where to write, what to write, write for whom.

Yakiv Mospan

May 15, 2014
Tweet

More Decks by Yakiv Mospan

Other Decks in Programming

Transcript

  1. • Where to write • How to write • Write

    for • Article content Technical Articles Writing
  2. Technical Articles Writing • Markdown is a text-to-HTML conversion tool

    for web writers. • Markdown allows you to write using an easy-to-read, easy-to-write plain text format, then convert it to structurally valid XHTML (or HTML). Where to write, Markdown
  3. Technical Articles Writing • Simple • Powerfull • HTML Based

    • Used in many services (GitHub, Stackoverflow, Codebase) Where to write, Markdown advantages
  4. Technical Articles Writing Where to write, Stackedit • Edit tools

    • Run time preview • Sync with Dropbox, Google Drive • Documentation • Possibility to get HTML
  5. Technical Articles Writing • Check if already exists • Ask

    yourself : is it interesting ? • Ask someone : is it interesting ? How to write, Choose theme
  6. Technical Articles Writing • Overview • Details with usage examples

    • Performance & Tips • Sample code • Links of data sources How to write, Uncover Issues
  7. Technical Articles Writing • Lets the title speak for you

    • Overview is the place where people close your article • Avoid Spaghetti Pattern - technical people like to read clean code and clean articles Write for
  8. Technical Articles Writing • Your reputation is under attack •

    Only proofed data • Double check that proofed data • Make it interesting • Easy to read / understand Article content