About#
JUNCTION BOX#
What’s in a name?#
The process of writing software is very similar to the electrical trade in the sense that things are wired up or connected.
Hence the name Junction Box, a place where things are connected.
Overview#
This project is about documenting how we use several technologies that meet the needs of our software development initiatives.
What#
To kick-off, we will be exploring and documenting these technologies:
When how we use the first two items has been documented, other technologies on our list include:
Continuous Delivery: Dave Farley Style.
Django: A python web framework.
Pytest: A software testing tool.
Hypothesis: A software testing tool.
Playwright: End-to-end testing for modern web apps.
How#
Create and follow a style guide.
Create standard layouts for content.
Follow the Diátaxis document content framework.
Only record what we have used and tested.
Why#
You want people to use your project.
If you have good documentation, people are more likely to use your project.
If people are more likely to use your project, you will have more contributors.
If people have trouble installing your project with poor documentation, they are more likely to opt out.
Continuous documentation is a critical task often overlooked or poorly executed.
Over time as memories fade, the need for good quality documentation becomes evident.
Things that make sense now often don’t make sense later.
When it is needed, good documentation can ease the load of remembering.
This may help some one else!
When#
Following Continuous Delivery Principles, this is a living document.