SharePoint & Microsoft Resources

Automated Documentation? Yes Please.

By Nick Murray, Delivery Lead

Automated Documentation? Yes Please.

Having spent my whole working life in agencies, I live for efficiency. Not only in the workplace, but I’m now all about efficiency in my life too – why waste your, or your client’s time (and money)? Whether you’re working at a new start-up or a well-established FTSE 100 business, there is always room for improvement in efficiency. Oh, and yes, for those that know me – I have just written an article about VSTS and documentation (Automated Documentation. Yes, Please).

In our case here at Silicon Reef, and probably in the case of 90% of technology companies/agencies, creating functional and technical documentation is a necessity, but far from efficient. We’ve just changed that. We have made a huge step forward in not only managing our projects but using our management tools to then automate our Functional Specifications. It works like a dream and helps set us apart from our competitors. So, how do we do it?

We use VSTS to manage our requirements, development, testing, releases etc. VSTS is a powerful tool and I would suggest to any company looking to work in a more agile manner to at least give it a once over – watch this video if you’d like more information. Forget the Microsoft stigma, it’s great for start-ups too.

Here is what we do:


We use VSTS to manage our requirements for a project. Using various techniques to actually obtain the requirements (post-it sessions, user interviews etc), we then manage all of these through the VSTS Backlog. We follow a common structure for our requirements and use three main Work Items in VSTS, with a couple of subtle differences to fit our Reef mould:

Epics; A related group of stories that are too large to define in one story

Stories; A description of a requirement and a reason for the requirement from an end user perspective

Features; The required technical feature to answer and solve the user story


Once we have all our requirements (at least for the release in question), we then organise them making use of the Related Work function in VSTS. This enables us to group all our work into a logical order, which helps us when we then want to export our Functional Specification. Epics become parents, Stories become children, and Features become children of their children, and so on.


Once we have the backlog completed, it’s time for the nitty gritty detail. Each of our Work Items now requires the detail to be populated. This is all the detail that a developer(s) would require to turn a functional requirement into a technical solution. We use a combination of text, screen views and, where required, prototypes to help identify our requirements and their functional solutions. This gives our developers all they need to then build out the Tasks in VSTS to build the technical solution for the requirement.

We also use the Wiki area of the VSTS Project to write our project overview. This acts as the introduction to the project for our documentation and contains the business case and some background information to help contextualise the project itself.


Once all our Work Items have the required description detail, we can run a query to return all Epics, Stories and Features and organise them using the Stack Rank feature – this gives us all our items, with their grouping in the correct Backlog order.


Once the query is setup and returning the correct results, we use an in-house product called Scryber to then generate the Functional Specification PDF. In a few minutes and magic clicks, the Functional Specification is created! More information to come in a future blog on what Scryber is and how it may be useful for your business.

This process will revolutionise our whole engagement with clients; from demand through to diagnostics. It doesn’t stop here either, we have plans to improve on this further and are already looking at:

  • Integrating all of this with our testing teams to automate testing documentation and processes even further.
  • Managing our development resources and estimation process. In the not too distant future, we’d love to be automating SoWs through VSTS, leaning on the Effort and Assigned capabilities within VSTS.
  • Further integrations of our product management to VSTS. Managing all requirements, documentation, processes, resources, testing, releases (the buzz word list is never ending) for our products and projects and where possible, automating as much of the documentation along the way.

More from Silicon Reef

The Emerging Innovative Practices of Hybrid Working

The Emerging Innovative Practices of Hybrid Working

Challenging times can bring about the perfect opportunity to do something different, and with many employers struggling to establish their own version of hybrid working practices – and find the right balance between home and office – we are seeing new innovative...

Coming Soon – Microsoft Loop

Coming Soon – Microsoft Loop

In November last year Microsoft introduced us to Microsoft Loop so, with the full release set for this summer, we thought it was time to welcome the newest app to join the Microsoft 365 platform and take a deep dive into its capabilities and benefits. What is it?...

The Hybrid Worker’s Guide to Combatting Loneliness

The Hybrid Worker’s Guide to Combatting Loneliness

Although most of us are yet to settle down into establishing long term ‘back to normal’ ways of working, it’s clear that hybrid working is here to stay for thousands of employees across the UK. The Silicon Reef Research Report, carried out in February 2022,...

Silicon Reef Welcomes New Chairman & Major Investor

Silicon Reef Welcomes New Chairman & Major Investor

We are excited to announce the appointment of Silicon Reef’s new Chairman and major investor, Tim Wallis, Founder & former CEO of Content and Code (now Content+Cloud). We are thrilled to welcome Tim to Silicon Reef as this marks another significant, enabling step...