Module revision

Learn the Uniscale process of 'how-to' do module revisions and approving your functional specifications in the solution editor.

This article assumes that you have covered knowledge around specification and concepts in solution basics. If not, it is recommended to follow those first in order to better understand this article.

The module revision flow

Your specification is written through multiple deliveries.

Whether you use an agile-based, waterfall or other methodology, this way of creating module revisions will allow you to iteratively build your specification.

In this article, we will do a breakdown and tutorial of the module revision flow.

First cycle

  • The first revision you write will take you into the "Write content" step.

  • In the first revision, all content is new so there would be nothing to unlock. However, you will still go through the step of marking your content as ready so that you can incrementally lock down parts of your specification.

  • When everything is marked as ready - click the "Approve" button, to approve the revision. This is the flow you will go through every time you want to release changes to your product.

General process afterwards

Every revision will go through the same flow of initiating;

  • Unlocking content you want to change

  • Writing/editing content and

  • Then lastly readying content and approving it.

Processes

Lockable cycle

Your modules, pages, sections, functional use cases and UX flows are all subject to the locking cycle.

Exploring step by step the process, we have :

  • When a new item is created, it has the status of "edited"

  • Once all requirements are met, it can now be "marked as ready"

  • When the owning module is Approved, all items are moved to "locked"

  • Later, when a new revision is made, all items are still in "locked"

  • From here, one can manually "unlock" the items that are intended for changes, and move them to "unlocked"

  • If any change is made to a "unlocked" item, it gets automatically moved to the status "edited"

Exploration with conceptual explanation

In the start you can have the following:

  • Content that is locked (marked as locked) - finished content

  • Unlocked - edited content

  • Untouched or just not locked (marked as edited) - draft content

  • And also items in ready

Interface walkthrough

Up next, we will illustrate the above cycle with interface screenshots and examples.

When utilizing services in your solution, service documentation occurs between content readiness and approval.

Unlocking and readying

When you start a new revision, everything is initially locked, meaning you haven't decided to make changes yet. To make changes, you must unlock the elements first. This helps you track what you've changed or plan to change.

Filters let you focus on unlocked or changed elements, especially useful as your specification grows. Unlocking can serve as an agreement with stakeholders on intended changes. Use it to track changes and align expectations.

Similarly, you can use readiness to track what's complete and what's left in your specification. Locking down parts of your specification as you progress helps you approach completion systematically.

Approval

For approval, if you're defining services, complete service revisions before approval. If you're only using functional specifications, you'll approve the specification after everything is marked ready. Once approved, the specification is locked, and you can start new revisions in the future.

For each module in your solution editor, you can work with the current revision and look back at any of your older revisions. In this way, you have a complete overview of the product intention and decision history.

When using "Mark as ready" or "Mark as unready" you can lock and unlock content bit-by-bit or bulk content within the editor. This can be useful if some parts are finished or more than one person is working on the same solution. See the how-to in GIF below:

By pressing "Approve" you generate a new revision and save the entire solution


Summary of module revision flow

You iteratively define your module's functionality by starting, specifying, and approving revisions in your module. You can use unlocking to align with stakeholders on what is expected to change existing functions. You can also use readying as a way of tracking your progress against completing your revision. Through multiple iterations and gradually adding functionality to your solutions modules the specification will be the single source of truth for all intentions and decisions making your product what it is today. Through the module revision history, you can go back in time and look at all your historical decisions.

Want more of a deep dive? Watch this video and see the module flow process exemplified:

Last updated