↓ Ir para o conteúdo principal

← todas as notas

📎 Webclip

Writing technical articles: tips for programmers

The article argues that programmers benefit from writing because it builds publicity, personal branding, company reputation, and knowledge sharing. It recommends focusing on work-related experience, researching existing material first, choosing a clear and specific title, and organizing the article with standard sections such as abstract, introduction, body, and summary.

It also advises adding relevant code snippets, pictures, and keywords, using at least five tags, and checking language carefully for clarity and correctness. It ends with practical tips like using present tense, keeping paragraphs short, expanding acronyms, and providing sources for data.

Reading notes
#

  • Writing articles can help a programmer be seen as an expert and trusted more by readers.
  • The main reasons to write are publicity, self PR and portfolio building, company reputation, and simple knowledge sharing.
  • Article topics should come from your own work experience or from learning curves and discoveries related to your work.
  • Before writing, check whether similar material already exists and only make a new piece if it adds an updated version, a controversial version, or more details.
  • A good title should be specific, clear, and not too long.
  • A common article structure is title, abstract, introduction, body with code or examples, conclusions or summary, and future work or references.
  • Topic-related pictures and code snippets make the article stronger when they fit the subject.
  • Tags and keywords help search engines and should relate to the technology, product, methods, and experience covered by the text.
  • Language should be checked carefully, especially for grammar, terminology, and readability.
  • Useful writing habits include using present tense, avoiding long paragraphs, expanding acronyms on first use, and citing sources for numbers or facts.