Best-Practices

Pages in this section

  • Context content conclusion (CCC)
    Last edited: 2024-01-21

    This is a model to structure writing. The idea is to separate what you are writing into 3 discernible blocks:

    • Context: Sufficient background information for people to read the content with purpose. This should include motivation and the set up for the problem.
    • Content: The substance to what you want to say and you show your approach to the problem.
    • Conclusion: Summarise what you have solved and how.

    Remember Start and end point bias !

  • Logging in python
    Last edited: 2023-11-11

    # logging python

    The logging module in python is used to do exactly what you would expect, it logs messages.

    Some cool features it has is:

    • different levels of messages for filtering of messages,
    • different logger names for different parts of the application,
    • different handlers to post messages such as streamed, files, http and rotating, and
    • custom formatters for different handlers.

    This library was converted from Java which is why it does not conform to the python naming conventions.

  • Separation of concerns (SoC)
    Last edited: 2026-02-05

    Separation of concerns (SoC)

    Separation of concerns (SoC) in software engineering is a design principle that advocates dividing a computer program into distinct and independent modules or sections, each addressing a specific concern or aspect of functionality. The goal is to enhance the modularity, maintainability, and comprehensibility of the code by isolating different responsibilities.