Skip to content
Compass

Product Documentation

At Crispr Coders, the team emphasizes the value of writing clear and concise product documentation. Here’s why it matters:

  1. Showcasing Expected Functionality, Requirements, and Logic:

  2. Identifying Cases and Uncovering Missing UX:

  3. Discovering and Defining Technical Dependencies and Strategy:

  4. Discovering Roadblocks:

  5. Aligning with Stakeholders:

Discovering Roadblocks

When writing product documentation, sometimes, a Product Manager might get halfway through the process of putting an idea on paper only to find out that there is a massive technical blocker or feasibility issue. This is something that might only be discovered with the process of putting everything inside a document. This phenomenon is not limited to technical blockers as it can also be applied to business pitfalls. For these reasons, it is of the utmost importance to begin writing documentation as early as possible.

i.e., The Product Manager wants to implement the login with Facebook feature. They discover during the documentation period that the market they plan to release it to has banned Facebook. Therefore the value of the feature is very low.

Who Does The Team Document For?

When creating product documentation, Product Managers must consider their diverse audience, which includes clients, developers (including Engineering Leads), and other Product Managers. The goal is to write in a manner that effectively communicates to both technical and non-technical participants, without neglecting relevant technical details.

  1. Clients:

  2. Developers (and Engineering Leads):

  3. Other Product Managers:

Where to Document

for each project we can create .docs folder and place documentation inside .docs folder.

Organizing the Documentation

Project's root directory
|___.docs
|______Product Documentation
|_________Feature A
|_________Feature B
|_________Feature C

Creating a Feature Documentation

When the Product Manager is ready to create documentation for a new feature, they must create a new page within the Product Documentation parent page and start documenting the why, the business logic and much more: