---
title: "Discussion on \"[JavaScript] - How to craft intuitive and self-documenting code\" | Hashnode"
description: "Discussion on \"[JavaScript] - How to craft intuitive and self-documenting code\". As a developer you probably spend more time reading code than actually writing it. Besides your regular outputs and refactors, think about the amount of time you spend on reading tutorials, documentations, reviewing a pull request, checking the lates..."
url: "https://hashnode.com/posts/javascript-how-to-craft-intuitive-and-self-documenting-code/5cfe9db51f82fa3d16d7d9ab"
---

[Feed](https://hashnode.com/feed) /

Discussion

# [\[JavaScript\] - How to craft intuitive and self-documenting code](https://adyngom.com/javascript-how-to-craft-intuitive-and-self-documenting-code?utm_source=hashnode&utm_medium=feed)

As a developer you probably spend more time reading code than actually writing it. Besides your regular outputs and refactors, think about the amount of time you spend on reading tutorials, documentations, reviewing a pull request, checking the lates...

Jun 10, 2019 · 8 min read · adyngom.com  
Updated Jul 8, 2022  
Read the article

-   [#javascript](https://hashnode.com/tag/javascript)
-   [#clean-code](https://hashnode.com/tag/clean-code)
-   [#web-development](https://hashnode.com/tag/web-development)
-   [#software-development](https://hashnode.com/tag/software-development)

## Written by

[Ady Ngom](https://hashnode.com/@adyngom)

@adyngom · Alpharetta, GA

  
[View profile](https://hashnode.com/@adyngom)

Building M.A.N.T.I.S (mantistech.io) | Angular Google Developer Expert | Talk and Teach about #Angular, #Javascript, #Web Development & Deve

Ady's first interaction with a computer was playing PacMan but he was more interested in knowing how it was built than how much fun it was to play it. For the past 20 years, Ady has strived in building simple, engaging and very intuitive consumer facing products. As a JavaScript Teach Lead and UI Architect, he spends a bulk of his time producing intuitive systems that are easy to scale and maintain. When away from the keyboard, he enjoys the Georgia outdoors with his wife and two daughters. To him, the unpredictable weather is a known issue that simply adds to the overall charm and he would not have it otherwise.

## Responses 1

Markdown supported · ⌘↵ to post

[JS Artisan](https://hashnode.com/@jsartisan)

[Jun 12, 2019](https://hashnode.com/posts/javascript-how-to-craft-intuitive-and-self-documenting-code/5cfe9db51f82fa3d16d7d9ab/comment/5d00c0100cac0d91440a4ec3)

I have one question - Do you still try to maintain a readable code when there is near to impossible deadline ahead of you?

[Ady Ngom](https://hashnode.com/@adyngom)

[Jun 12, 2019](https://hashnode.com/posts/javascript-how-to-craft-intuitive-and-self-documenting-code/5cfe9db51f82fa3d16d7d9ab/comment/5d00c0100cac0d91440a4ec3#reply-5d01022a41a9ff5751bb007b)

Hello Pawan.

Having an "impossible deadline" is an issue that far outweighs any coding style you adopt. As a developer, you invest in your craft to actually make your tasks more manageable. Clean code when executed right, actually speeds up the process of the Software Development Life Cycle (SDLC).

Let's see why, your code is easier to read for you and your peers who are suppose to review it before approving it. Once you have solved and abstracted certain functionalities those become reusable bits making subsequent development of similar features a breeze. On top of that your code is easily testable and maintainable so anytime there is an issue it takes a matter of seconds to locate the probable cause.

Now of course, like any other craft, it will take time and practice. As I mentioned in the article:

"I have honestly started to make that extra “craft” effort in the past few months and I can admit that it was a very, very slow start."

And I highly suggest that one starts with small refactors before undertaking a huge and hard to manage switch. We are creatures of habit and making clean code "natural" to us will be like anything else the result of practice and repetition.

Hope it helps. Cheers :)
