Documenting customization requirements and solutions
When we work with scripts in clients' accounts, we usually need to create a couple of types of documentation to support our work. It's not enough to just have automations running in the account – users need to know how they affect their work, and administrators need to know how to maintain/change them in the future. The first document we typically provide to clients is a requirement and design document. This should be a very plain English document which any user can make sense of. This isn't the place for a lot of technical terms or code samples or even what we sometimes call pseudo-code. Instead, I like these documents to have at least three sections:
- A clear statement of the problem we're trying to solve with the customization.
- A detailed functional description of the client's requirements for it.
- A good understandable description of the solution we'll create to meet the requirements...
