Getting Started with Office Knowledge

Office Knowledge turns the Pyvoid User Guide into a living knowledge base for your firm. Alongside the built-in tool documentation, you can publish firm-wide articles (standards, checklists, how-tos) and keep personal notes - all searchable from one place.

What is Office Knowledge?

Office Knowledge adds two article sources to the User Guide sidebar:

• Firm articles - shared Markdown files that every team member sees. A BIM Manager drops .md files into the firm folder and they appear for the whole office.
• Personal articles - your own notes stored locally. Only you can see them.

Both types sit right next to the built-in tool docs, so there is one place to look for answers instead of three.

Browsing Articles

Open the User Guide via CommandHub (press Ctrl+Shift+P or use the Settings panel). In the sidebar you will see a Knowledge Base section beneath the tool documentation tree. Articles are grouped by category:

• Best Practices - recommended workflows and tips
• Firm Standards - naming rules, model requirements, submission checklists
• Tutorials - step-by-step walkthroughs
• Project Notes - project-specific decisions and references

Click any article title to read it in the main content area.

Searching

The search bar at the top of the User Guide searches across everything: tool docs, firm articles, and personal notes. Results are ranked by relevance, and each hit shows a snippet so you can find the right article quickly.

Use tags to narrow results. For example, searching tag:naming returns every article and tool doc tagged with "naming."

Creating Personal Articles

To add a personal article:

1. Navigate to the personal articles folder on disk (shown in User Guide settings).
2. Create a new .md file with the required frontmatter block at the top (title, type, category, author, tags, etc.).
3. Write your content in standard Markdown.
4. Reopen or refresh the User Guide - your article appears in the sidebar.

Alternatively, use the Template Wizard inside the User Guide. Click the New Article button, pick a category, fill in the title and tags, and the wizard generates a ready-to-edit file with valid frontmatter already in place.

Firm Folder Setup (BIM Managers)

To publish articles for the entire office:

1. Create a shared network folder (or a synced cloud folder) accessible to all team members.
2. In Pyvoid settings, set the Firm Knowledge Path to that folder.
3. Drop .md files into the folder using the same frontmatter schema as personal articles.
4. Every team member who has the path configured will see the articles on their next User Guide refresh.

Keep file names lowercase with hyphens (model-setup-checklist.md) for consistency.

Tips

• Keep articles short. A focused 200-400 word article is more useful than a 2,000-word document nobody reads.
• Use tags generously. Tags power search and cross-references.
• Update last_updated. It helps readers know whether an article is still current.
• Link to tool docs. You can deep-link to any built-in tool page from your article Markdown.

Last updated: 2026-03-20