Skip to content

Commit

Permalink
Add new blog post
Browse files Browse the repository at this point in the history
  • Loading branch information
QubitPi committed Aug 7, 2024
1 parent 0d00865 commit 7d58500
Showing 1 changed file with 25 additions and 2 deletions.
27 changes: 25 additions & 2 deletions src/content/posts/literate-programming/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,34 @@
title: Literate Programming
published: 2024-08-07
description: |
Software is made for human not only in terms of users using it, but also for the better of people who made it
Shaping a Tech team culture toward literate programming
image: './cover.png'
tags: [ "English" ]
category: Technology
draft: true
---

I was studying Jupyter notebooks
I was studying Jupyter Documentation and stumbled upon [this article](https://jupyter-docs.qubitpi.org/en/latest/what_is_jupyter.html)
which introduced to me the first time __[Literate Programming](https://en.wikipedia.org/wiki/Literate_programming)__.

I [read about it](http://www.literateprogramming.com/knuthweb.pdf) and ended up couldn't agree with it more. Literate
Programming significantly improves documentation of programs for human by concentrating on explaining to _human beings_
what we want a computer to do.

The practitioner of literate programming can be regarded as an essayist, whose main concern is with exposition and
excellence of style. Such an author, with thesaurus in hand, chooses the names of variables carefully and explains what
each variable means. He or she strives for a program that is comprehensible because its concepts have been introduced in
an order that is best for human understanding, using a mixture of formal and informal methods that reinforce each other.

As a leader who has been a beneficiary of excellent code readability and maintainability, it is my responsibility to
coach my team to follow the same practice of Literate Programming.

Literate Programming has her perfect fit in [Jupyter Notebooks](https://jupyter-notebook-docs.qubitpi.org)

- [Write the Docs](https://qubitpi.github.io/writethedocs/) focuses on how a programmer writes better documentations
- [Clean code](https://trello.com/c/5W6W5T0b) goes deeper in a systematic way

Those above are for engineers. But how about the manager or leader to leads the team? How would we boost a proactive
mindset among the team where each one of them has the consciousness?

To be continued...

0 comments on commit 7d58500

Please sign in to comment.