Angular Thoughts on Docs: Looking Back, Looking Ahead

Angular Thoughts on Docs: Looking Back, Looking Ahead

As the last quarter of 2020 comes to an end, it’s a good opportunity to look back on some of the work we’ve done with the Angular…

The start of a new year is a good opportunity to look back on some of the work we’ve done with the Angular documentation. I find these reflection opportunities helpful; they allow me to really examine what we’ve accomplished, what we weren’t able to achieve, and what we should focus on next. Usually, I do these sorts of reflections on my own; this time, I thought I’d share my thoughts with the community.

Our Q4 focus

As our recent survey shows, the Angular community really values documentation.

A bar chart that showing that 28% of survey participants list documentation as “most important.”

Bar chart showing that 28% of Angular developers ranked documentation as “most important”.

One of my first priorities when I joined the Angular team was to identify what areas of the documentation were in most need of improvement. As I listened to both the product team and the community, one thing stood out: We need to do a better job of introducing Angular to developers. Consequently, as we started our Q4 work, we decided to focus on developers new to the Angular framework. This decision led us to focus on content that we felt was most important to this audience, such as the Getting Started section. We also focused on content that we think would be the most impactful to those thinking about or just starting their journey with Angular, such as our content on Components, Templates, Directives, and Dependency Injection.

Editing, editing, and more editing

As part of this focus, we spent a significant amount of time editing our existing content. Our editing process was more than just fixing typographical and grammatical errors. We examined each topic thoroughly, reviewing whether the content was relevant and, if so, whether those ideas were communicated clearly, concisely, and completely. We took large, overwhelming topics and split them into smaller, more manageable sections. We examined how we communicated ideas to ensure that we didn’t use 20 words when 10 words would do. Most importantly, we removed duplicated content when we found it, and put together a system to archive content we thought might be outdated. If you look at the content in our Getting Started and Understanding Angular sections, you should find the content much easier to read.

angular documentation

What is Geek Coin

What is GeekCash, Geek Token

Best Visual Studio Code Themes of 2021

Bootstrap 5 Tutorial - Bootstrap 5 Crash Course for Beginners

Nest.JS Tutorial for Beginners

Hello Vue 3: A First Look at Vue 3 and the Composition API

Install Angular - Angular Environment Setup Process

Install Angular in easy step by step process. Firstly Install Node.js & npm, then Install Angular CLI, Create workspace and Deploy your App.

Basics of Angular: Part-1

What is Angular? What it does? How we implement it in a project? So, here are some basics of angular to let you learn more about angular. Angular is a Typesc

Angular Sass: How To Use Sass In Angular 9 Tutorial

Sass in Angular is an extension of CSS that allows you to use things like variables, nested rules, inline imports. Angular supports Sass, CSS, and Less.

Angular 11 Facebook Social Login Example

Angular 11 login with facebook. In this tutorial, you will learn how to login with facebook in angular 8/9/10/11 app.

Angular 11 Google Social Login Example Tutorial

Angular 11 google login example. In this tutorial, you will learn how to integrate google social login in angular 11 app.