From 3a4bbbce321041c67dd325600cca2c331718a9a1 Mon Sep 17 00:00:00 2001 From: Amos Chebii <105730820+AmosCheby@users.noreply.github.com> Date: Thu, 30 Jun 2022 01:33:58 +0100 Subject: [PATCH 1/2] Added 'Docs for Developers' to the list of books --- resources.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/resources.md b/resources.md index 82c62f0..9cee107 100644 --- a/resources.md +++ b/resources.md @@ -30,6 +30,9 @@ Linguist Steven Pinker takes an analytical approach to writing in this style gui ### 'Technical Blogging' by Antonio Cangiano This book is, as you may have guessed from the title, specific to technical blogging. "Successful people often get recognition by teaching what they know. Blogging is a reliable path to do that, while gaining influence in the process." Unlike most of the others here, it doesn't focus as much on writing well, but more about how to set up a technical blog, how to promote it and how to find time to write. +### 'Docs for Developers' by Jared Bhatti et al. +This book by a diverse group of accomplished technical writers sheds light on fundamental concepts of technical writing, especially in the software development world. It is important for technical writers who are looking to create succint developer documentation including API docs, user guides, tutorials, friction logs, READMEs, etc. + ## Articles ### 'Writing well' by Julian Shapiro From 26987ff3139cac48cc0e86bd30b4151d3c8bdf00 Mon Sep 17 00:00:00 2001 From: amos chebii Date: Thu, 30 Jun 2022 02:33:39 +0100 Subject: [PATCH 2/2] addeed --- resources.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/resources.md b/resources.md index 9cee107..8a81a1a 100644 --- a/resources.md +++ b/resources.md @@ -31,7 +31,7 @@ Linguist Steven Pinker takes an analytical approach to writing in this style gui This book is, as you may have guessed from the title, specific to technical blogging. "Successful people often get recognition by teaching what they know. Blogging is a reliable path to do that, while gaining influence in the process." Unlike most of the others here, it doesn't focus as much on writing well, but more about how to set up a technical blog, how to promote it and how to find time to write. ### 'Docs for Developers' by Jared Bhatti et al. -This book by a diverse group of accomplished technical writers sheds light on fundamental concepts of technical writing, especially in the software development world. It is important for technical writers who are looking to create succint developer documentation including API docs, user guides, tutorials, friction logs, READMEs, etc. +This book by a diverse group of accomplished technical writers sheds light on fundamental concepts of technical writing, especially in the software development world. It is important for technical writers who are looking to create succint developer documentation including API docs, user guides, tutorials, friction logs, READMEs, etc. This book generally demystifies the overall software documentation process using clear examples, templates, and principles.This book can be found on Amazon. ## Articles