AlephAITech/WorkBuddyGuide

What it is

WorkBuddyGuide is a community-written, practical handbook ("blue book") for using WorkBuddy — an AI tool. It is explicitly not an official manual or a rewrite of one. Instead, it walks readers through real tasks, from a first simple job all the way up to building a team of AI agents that can be reused across an organization.

What's inside

The book is organized into four parts plus an appendix:

• Part 1 — User manual: downloading, installing, the interface, your first task, Skills (reusable capabilities), connectors, APIs, and automation.
• Part 2 — Case studies: concrete examples across office work, files, remote work, news, knowledge management, meetings, investing, video, self-media, and GEO.
• Part 3 — Advanced topics: creating your own Skills, designing multi-Agent systems, and making automation reliable.
• Part 4 — Roles & industries: suggested usage paths for different job positions and industry workflows.
• Appendix: ready-to-use command templates and a quick-reference table of scenarios.

How to read it

The README suggests three entry points depending on your situation:

• First-time user: start at Chapter 1 and go through Part 1 in order.
• Have a specific task: jump straight to the matching case in Part 2, then read Part 3 afterward.
• Preparing for team rollout: focus on Parts 3 and 4, and note down permission boundaries, acceptance criteria, and fallback plans.

The "Help you solve" feature

If you have a real work scenario but don't know how to accomplish it with WorkBuddy, you can submit a questionnaire at workbuddy.homes/help/. You describe the problem, your current approach, the materials you'd use, the expected outcome, and your security boundaries. The team reviews each submission. If a problem is representative and reusable, they may turn it into a full open-source case — documenting the Skill used, installation steps, task description, execution process, and final results — and publish it to the community case collection.

Contributing cases

Contributions are welcome, but the project prioritizes real, reproducible WorkBuddy use cases. Before submitting, check the community case collection and the book's table of contents to avoid duplicates. If your case targets the same goal but uses different Skills, methods, or deliverables, explain the difference in your pull request.

Each case must include at least:

• Scenario & problem: who faced what difficulty in which task.
• Skill used: its purpose, source, installation, and required configuration.
• Task description: the prompts, steps, or automation settings entered in WorkBuddy.
• Execution process: key operations, permission requirements, input materials, and security boundaries.
• Actual results: screenshots or other proof of the final output.
• Acceptance criteria: how to judge that the task was completed correctly.

Submissions go in docs/cases/submissions/ using the provided templates. After review and merge, the case automatically appears in the website's sidebar; particularly representative cases may be further reproduced and edited into official book chapters.

Local development

To run the site locally you need Node.js 20–24 (Node.js 22 recommended). Commands:

npm install
npm run dev

For a local build:

npm run docs:build
npm run docs:preview

Tech stack & deployment

The site is built with VitePress and deployed via Cloudflare Pages connected to the main branch of the GitHub repo — every push triggers an automatic build and deploy.

Reading online

The recommended way to read the book is at workbuddy.homes, which offers a full sidebar, full-text search, chapter navigation, dark mode, flowcharts, and mobile support. GitHub is better for understanding the project and contributing; the website gives a more complete reading experience.

Authors & license

The book is maintained by multiple community authors (credited with QR-code cards in the README). The project is open-sourced under the MIT License, so you're free to use, copy, modify, and distribute it as long as you retain the original copyright notice and license text.

Important caveat

The README explicitly states this is a community-maintained knowledge base. For time-sensitive information about WorkBuddy's features, interface, pricing, availability, or security policies, always check the official WorkBuddy channels.