A little longer, a little less · Save 28% for 6 months or 50% for a year, paid once See the plans ↗

Service planning · 5 min read

Give your shared wiki a complete little plan.

A shared wiki needs more than a place to put pages. Give it a named owner, a dependency map, a small permission model and a recovery check that includes its attachments. This worksheet helps a group decide what it is prepared to maintain.

Before you begin

  • A list of the people who will read, edit and administer the wiki.
  • The documentation for your chosen wiki and its intended version.
  • A place for operating notes and a separate, controlled location for recovery credentials.

1. Describe the job the wiki will do.

Start with one sentence: “Members use this wiki to find the current instructions for running our shared workshop.” That hypothetical purpose is narrower than “put everything online.” It suggests a manageable first collection: opening procedures, equipment notes and decisions from meetings. Personal contact details and access credentials need their own decisions; a convenient search box is not a reason to collect them.

List what a reader must accomplish, such as finding the latest procedure, opening a referenced diagram and knowing who owns an outdated page. Choose a small sample of real content to assess the application later. Do not infer a memory requirement from the number of members alone: uploads, indexing, extensions and simultaneous work can change the workload.

2. Make one page for the dependencies.

Use this example as a starting map, then replace every assumption with the layout of your chosen application. “Owner” means the person who can explain and recover that component, not necessarily the person who installed it.

PartWhat belongs in the notebookRecovery question
Web applicationVersion, configuration location and service ownerCan another maintainer rebuild the same version?
DatabaseEngine, version and backup methodWhich snapshot belongs with the files?
Images and attachmentsStorage paths and growth estimateDoes a restored page open its diagram?
DNS and HTTPSDomain account owner and certificate methodWho can repair access without the wiki?
Email and scheduled workSender, schedule and failure ownerWhat still works when delivery fails?

Record search as well: is it part of the application, a rebuildable index, or another service? Do not assume an index can be discarded until the application documentation confirms how to rebuild it.

3. Separate reading, editing and administration.

For the workshop example, members read procedures, a small editing group changes them, and two authorized maintainers manage accounts. Host administration is a separate responsibility. Write down who can publish a page, upload files, export content and change permissions. Decide how a departing member loses access and who reviews pages they maintained.

Application permission rules can combine in surprising ways. BookStack, for example, combines abilities across a user’s roles and supports content-level overrides; shelf permissions do not automatically cascade to their books. Check the effective result using ordinary member accounts, not only an administrator account. BookStack roles and permissions.

4. Keep the recovery set together.

Give each backup set a date, application version and note about which database and file copies belong together. Store the instructions somewhere that remains accessible if the wiki fails. Keep secrets in suitable secret storage; the notebook should identify who can retrieve them and where, without reproducing their values.

For a concrete application example, BookStack’s backup guidance covers database records plus configuration, uploaded images, attachments and any themes. Its configuration includes a key relevant to encrypted application data, so copying only visible pages misses important recovery material. Follow the application’s own procedure for your version. BookStack backup and restore.

Choose an independent copy destination and a named person to check that it remains accessible.

5. Agree a routine the group can sustain.

Choose a review interval the maintainers can actually keep. At each review, look at failed backups, pending application updates, attachment growth and accounts that no longer need access. Keep urgent security updates outside that routine when they require earlier attention. Write the next action and its owner rather than collecting an ever-growing list of vague concerns.

In the example, the editing group also checks a short “needs review” list. An equipment procedure without an owner should be visibly marked for review instead of quietly looking authoritative. Before a significant update, note the working version, the application’s migration instructions and the recovery point you intend to use if validation fails.

6. Prove the useful path, then record gaps.

On a separate test copy, ask the second maintainer to find a sample page, open its attachment, make an authorized edit and try an action their account should not allow. Check a search result after a content change. Record expected and observed outcomes; a successful sign-in alone does not prove the wiki is usable or correctly restricted.

If an attachment is missing, compare its storage location and backup set before editing database records. If permissions differ, inspect account roles and content overrides before widening access. If the application cannot start, stop the exercise and record the version or configuration mismatch. These are acceptance steps to perform, not reported tests of Hoszen infrastructure.

7. Leave a path out.

Pick one representative chapter to export and ask whether someone could read it without the original wiki. Treat that readable copy as a separate deliverable from the recovery set: it may not preserve accounts, permissions or application settings. Agree who maintains this exit copy when the content changes.

Your finished plan should fit beside the service inventory, not replace it. Continue with a portable export folder and a restore drill. The goal is a wiki another authorized person can understand and recover; no application is installed by this guide.

Documentation behind this note

Use the documentation for the version you actually run. These examples are planning material, not a record of a test on a Hoszen VPS.