Support & operations · Practice guide

Document the settings needed to rebuild your service

Illustrative situation

A working application relies on undocumented settings changed during earlier incidents. Rebuilding from source alone would not reproduce its behaviour. A working application may depend on settings that nobody has documented. Rebuilding its files then fails to reproduce the service. Record the purpose and ownership of important settings without putting secret values into ordinary documentation.

Healthcare website support desk with a system checklist, telephone and orange notebook.
Know who to call and what help your support arrangement includes.

What this means for your practice

Keep maintained instructions for important settings, their purpose and approved ownership without exposing secret values. Connect significant changes with the record of the released version.

An example to discuss with your team

Recreate a fictional test environment from the documented configuration process and note every setting that still requires personal recollection.

Healthcare website maintenance with infrastructure, a status panel, tools and an operational checklist.
Monitor the useful journey, not just whether a server responds.
Healthcare backup and recovery illustrated by storage copies, an archive folder and a restoration route.
Test whether a backup can restore a usable service.

How to review the arrangement

Ask the supplier to recreate a fictional test environment using the approved instructions. Which settings still require someone's memory? Connect significant changes to the release history and recovery process. The practice needs confidence that authorised maintainers can reproduce the arrangement when the original engineer is unavailable.

Record the settings that make the service behave as expected

Ask the supplier to identify the important settings needed to recreate the service in its approved environments. The instructions should explain each setting's purpose, owner and authorised source without putting secret values into ordinary documentation. Separate routine choices from details that affect connected services or recovery. Link significant changes to the release history so a later maintainer can understand why the current arrangement differs from the original setup.

Have an authorised colleague build a fictional test environment using the documented process. Note every point where they need somebody's memory, a private message or an unexplained value. Resolve those gaps through the approved access and documentation routes, then repeat the relevant step. Keep the instructions maintained as settings change. A useful record supports an understandable rebuild and investigation process; a large dump of configuration values may still leave the next person unable to explain which ones matter or how to obtain them appropriately.

How to check the result

Measure undocumented configuration dependencies found during rebuild exercises.

Turn reading into a next step

Your action checklist

Work through these checks with your team or supplier. Tick the ones you have resolved and leave unknowns open.

Checks to discuss

Record what you know, what is still missing and the answer you need from your team or supplier.

Use project decisions only, without personal, patient or confidential details. Entries stay in this page and are not submitted to Kay & Co. Copy or download before leaving; this page does not save your notes.

Further reading

These sources provide background for the topic. The practice examples and checklist are illustrative planning suggestions from Kay & Co.

Related guides

Need help with this?

Tell us what is getting in the way. Kay & Co. can help you understand the options and turn the next step into something that works for your practice.

Explore support & operations services or discuss your project.

Try the free Healthcare Digital Planner to find your starting priority.