Clients are provided detailed documentation for all web projects. The following sections describe why and what to include.
In addition to a fully working website, clients should be provided documentation explaining how to maintain and update the site. This involves explaining the fundamental elements such as Slices and CMS custom types.
The better we can describe how the site should be maintained and updated, the better the site will function and look down the road.
Documentation should cover the following:
- How to use Prismic
- How to build and update pages with Slices
- What Slices are available
- What content types are available and how they interact with eachother
- How to perform tailored common workflows for their site. (think: How to update news posts, etc.)
The client reference documentation lives directly within the project's codebase. Under the hood, this project utilizes Storybook to streamline the process of creating client documentation.
Storybook provides an isolated development environment via .stories files.
These .stories files allow developers to author components in a way that
facilitiates creating components that are more robust, reusable, and generate
useful interactive documentation. By using Storybook, we aim to reduce the
amount of friction required to create great client documentation by making it a
natural part of the project workflow.
In practice, this means that it's recommended to do the majority of your development in Storybook, and not within the Gatsby development server.
When making changes to an already developed site, be sure to make the proper
additions and changes to any corresponding .stories files. This will make it
easier for not only clients to understand the site as it evolves, but also to
Wall-to-Wall employees that are maintaining the site going forward.