Content
<p align="center">
<a href="https://workbuddy.homes/">
<img src="./assets/workbuddy-guide-banner.png" alt="WorkBuddy Guide: Home Preview" width="100%">
</a>
</p>
<h1 align="center">WorkBuddy Practical Guide</h1>
<p align="center"><strong>From the first task to an AI team</strong></p>
<p align="center">
English · <a href="./README_en.md">English</a> ·
<a href="https://workbuddy.homes/">Online Reading</a> ·
<a href="./docs/reading-guide.md">Reading Guide</a> ·
<a href="./CONTRIBUTING.md">Contribute</a>
</p>
> This is not a rewritten version of the official functional manual, but a practical guide based on real tasks. Start by completing the installation and the first task, then move on to mobile office, knowledge management, professional diagnosis, content automation, and multi-agent teams. Finally, turn a successful experience into a reusable work system for the team.
## Online Reading
Recommended to visit **[workbuddy.homes](https://workbuddy.homes/)** for reading. The website provides a complete sidebar, full-text search, chapter directory, dark mode, flowchart, and mobile adaptation.
GitHub is suitable for understanding the project and participating in contributions; for actually reading the guide, the website experience is more comprehensive.
## What You Will See Here
| Part | Content |
| --- | --- |
| Part 1 · User Manual | Download, installation, interface, first task, Skill, connector, API, and automation |
| Part 2 · Case Studies | Office, documents, remote work, news, knowledge, meetings, investment, video, self-media, and GEO |
| Part 3 · Advanced | Building Skills, multi-agent system design, automation reliability |
| Part 4 · Positions and Industries | Usage routes for different positions and industry workflows |
| Appendix | Common command templates and scenario quick reference tables |
## Recommended Reading Methods
- **First-time use**: Start from [Chapter 1](./docs/bluebook/Part%201%20User%20Manual%3A%20Getting%20Started%20with%20WorkBuddy/Chapter%201%20Getting%20Started%20with%20WorkBuddy/index.md) and complete Part 1 in order.
- **Already have a specific task**: Directly go to the corresponding case in Part 2, run through it, and then read Part 3.
- **Preparing for team implementation**: Focus on reading Parts 3 and 4, and record permission boundaries, acceptance criteria, and failure rollback.
See [How to Read This Guide](./docs/reading-guide.md) for a more complete route.
## Local Reading and Development
Requires Node.js 20~24, recommended Node.js 22.
```bash
npm install
npm run dev
```
Local build:
```bash
npm run docs:build
npm run docs:preview
```
## Contribute
Welcome to contribute:
- Correction of typos, invalid links, and outdated information.
- Reproducible real work cases.
- Skill, connector, API, and automation practices.
- Position roadmaps and industry workflows.
- Website navigation, search, style, and accessibility experience improvements.
Please read the [Contribution Guide](./CONTRIBUTING.md) first. If you don't want to modify the code, you can also submit an [Issue](https://github.com/AlephAITech/WorkBuddyGuide/issues).
## Directory Structure
```text
WorkBuddyGuide
├─ docs/
│ ├─ .vitepress/ # Website configuration and theme
│ ├─ bluebook/ # Guide content, images, videos
│ ├─ community/ # Contribution instructions
│ └─ index.md # Website homepage
├─ scripts/ # Content synchronization tools
├─ CONTRIBUTING.md
├─ README.md
└─ README_en.md
```
## Deployment
This site uses **VitePress + Cloudflare Pages + GitHub**. After connecting to the `main` branch of this repository, Cloudflare Pages automatically builds and deploys on each push. See [DEPLOYMENT.md](./DEPLOYMENT.md) for configuration.
## Authors
Thanks to the following authors for their joint participation in the creation and maintenance of the WorkBuddy Guide. Click on the card to view the original image and scan the QR code.
<p align="center">
<a href="./assets/authors/jia-mu-wei-lai-pai.png"><img src="./assets/authors/jia-mu-wei-lai-pai.png" alt="Jia Mu Wei Lai Pai" width="48%"></a>
<a href="./assets/authors/mo-yu-xiao-li.png"><img src="./assets/authors/mo-yu-xiao-li.png" alt="Mo Yu Xiao Li" width="48%"></a>
</p>
<p align="center">
<a href="./assets/authors/dai-shu-di-ai-ke-zhan.png"><img src="./assets/authors/dai-shu-di-ai-ke-zhan.png" alt="Dai Shu Di AI Ke Zhan" width="48%"></a>
<a href="./assets/authors/cang-he.png"><img src="./assets/authors/cang-he.png" alt="Cang He" width="48%"></a>
</p>
<p align="center">
<a href="./assets/authors/liu-cong-nlp.png"><img src="./assets/authors/liu-cong-nlp.png" alt="Liu Cong NLP" width="48%"></a>
</p>
## Statement
This project is a community-maintained WorkBuddy practical knowledge base. For time-sensitive information such as product features, interface, pricing, availability, and security strategies, please refer to WorkBuddy's official channels.
## License
This project is open-sourced under the [MIT License](./LICENSE). You can freely use, copy, modify, and distribute this project, but you need to retain the original copyright notice and license text.
