# Univer Office SDK Documentation

> Agent-readable documentation for Univer Office SDK, which includes Web SDK, Server SDK, and AI SDK.

- Language: `zh-CN`
- Documentation version: `1.3.0`
- [Full documentation bundle](https://docs.univer.ai/zh-CN/llms-full.txt): Development guidance followed by the complete Web SDK, Server SDK, AI SDK, and API reference content.

## Required workflow before application development

Do not begin development after reading only this index, a single documentation page, or isolated code snippets. Before writing code, complete the following steps:

1. **Read the relevant documentation.** Read the relevant pages in full, including linked prerequisites and architecture guidance. Understand the recommended workflow, module responsibilities, and required packages.
2. **Read the complete examples implementation.** Clone the relevant examples repository unless an up-to-date local checkout already exists. Choose the closest example and read its README and complete source, not only its entry points or snippets shown in the documentation. Follow the actual execution flow through dependencies, configuration, entry points, module registration, shared code, data flow, and resource disposal. Continue into referenced files as needed until you understand how the complete example works.
3. **Read the relevant package READMEs.** Identify the SDK packages used by the application, then read the SDK's root README and every relevant package README. Confirm their responsibilities, public APIs, initialization, configuration, resource disposal, and version requirements. If the application uses a version different from the repository's default branch, use the installed package's types or source as the reference.
4. **Implement only after completing this research.** Use the documentation, the examples' complete assembly, and the package READMEs together. Do not invent APIs.

Relevant repositories:

- Collaboration: [examples repository](https://github.com/dream-num/univer-collaboration-examples) and [SDK repository](https://github.com/dream-num/univer-collaboration-sdk).
- CLI: [examples repository](https://github.com/dream-num/univer-cli-examples) and [SDK repository](https://github.com/dream-num/univer-cli-sdk).

## Documentation scope

- [Office SDK overview](https://docs.univer.ai/zh-CN/overview): SDK responsibilities, composition, and getting started.
- [Web SDK](https://docs.univer.ai/zh-CN/guides): Embedded editors, headless runtimes, presets, plugins, Facade APIs, and frontend features.
- [Server SDK](https://docs.univer.ai/zh-CN/server): Self-hosted Collaboration SDK, storage, authorization, and Office import/export packages.
- [AI SDK](https://docs.univer.ai/zh-CN/ai): Agent content operations, visual inspection, CLI composition, and reviewable Worktrees.

## Product guides

- [Univer Sheets 简介](https://docs.univer.ai/zh-CN/guides/sheets.md): Univer Sheets 是 Univer Office SDK 的电子表格组件，支持浏览器和 Node.js，具有灵活、可扩展和可定制的特性。
- [Univer Docs 简介](https://docs.univer.ai/zh-CN/guides/docs.md): Univer Docs 是 Univer Office SDK 的电子文档组件，支持浏览器和 Node.js，具有灵活、可扩展和可定制的特性。
- [Univer Slides 简介](https://docs.univer.ai/zh-CN/guides/slides.md): Univer Slides 提供 Univer Office SDK 中的演示文稿编辑产品能力。
- [Univer Boards 简介](https://docs.univer.ai/zh-CN/guides/boards.md): Univer Boards 为白板、图表、表格和思维导图提供画布工作区。
- [Univer Bases 简介](https://docs.univer.ai/zh-CN/guides/bases.md): Univer Bases 提供一个包含表、字段、记录、公式和多种视图的结构化数据工作区。
- [Univer PDFs 简介](https://docs.univer.ai/zh-CN/guides/pdfs.md): Univer PDFs 提供浏览器端 PDF 查看器与编辑器，支持持久化文档数据、Facade API、导入导出、协作和打印。
- [Univer Icons 简介](https://docs.univer.ai/zh-CN/guides/icons.md)

## Documentation indexes

- [Server SDK](https://docs.univer.ai/zh-CN/server/llms.txt): Collaboration and import/export.
- [AI SDK](https://docs.univer.ai/zh-CN/ai/llms.txt): Agent operations and Worktree.
- [Guides](https://docs.univer.ai/zh-CN/guides/llms.txt): Product setup, concepts, features, UI, recipes, and server integration.
- [API reference](https://docs.univer.ai/zh-CN/reference/llms.txt): Packages, presets, plugins, classes, methods, types, and Facade APIs.