Writing Articles about Tasks Instructions
For tasks where we have not done something similar before, a post should be created that is a resource explaining any challenges faced, decisions made and a basic overview of how the change was done so that it can be referred to in the future. This should be considered a living document, meaning that it can start out with a small amount of info and be edited over time. Things that should go in the document: Initial challenges or questions that seem significant, where they are not just minor questions but bigger questions about which is the proper approach to take or things related to overall architecture. Information about bugs that came up or anything unexpected so that this can be referred to for the future. Questions that come up, the question can be put here first and then the response can be answered later. Code snippets, code snippets should be included where possible to best show the points being made.