Как читать эту документацию
Структура сайта, маршруты чтения по ролям и из каких исходных материалов собрана документация.
Документация разделена на четыре уровня — от продуктовой картины до машинно выверенного справочника API.
Структура
Заголовок раздела «Структура»| Раздел | Для кого | Содержание |
|---|---|---|
| Платформа | Продукт, пресейл, закупка, служба безопасности | Продуктовая формула, состав поставки, настройка под свой бренд, паритет с Word и Excel, пилот и коммерческие условия. |
| A4 | Архитекторы и интеграторы документной части | Архитектура, жизненный цикл, установка, быстрый старт, Surface, Host API, рецепты. |
| F1 | Архитекторы и интеграторы табличной части | Слои, среды выполнения, установка, первый проект, сеанс API, набор для встраивания. |
| Справочник A4 | Разработчики | Rust Session Protocol (28 команд), Surface API, window.fastdocShell (306 методов), события, каталог DTO (479 типов). |
| Справочник F1 | Разработчики | Compute Contract: транспорт, соглашения сеанса и 203 операции по доменам. |
Маршруты чтения
Заголовок раздела «Маршруты чтения»Оценка за один вечер. Что такое FastOffice → Что вы получаете → Функциональный паритет → Пилот и приёмка.
Технический прототип A4. Установка A4 → Быстрый старт → Объекты запросов и ответов → Команды сеанса.
Технический прототип F1. Установка F1 → Быстрый старт: первый проект → Как устроен сеанс API → Справочник Compute Contract.
Проектирование интеграции A4. Архитектура → Жизненный цикл → Host API → контракт взаимодействия → Что зафиксировать до интеграции. Две страницы в середине описывают интерфейс, который ещё предлагается, а не работает: по ним договариваются о форме будущего контракта. Что доступно сегодня — Готовность и границы.
Проектирование интеграции F1. Архитектура: четыре слоя → Что происходит от открытия до сохранения → Среды выполнения → Интеграция в приложение → Контрольный список готовности.
Проверка безопасности. Безопасность платформы → Ответственность и безопасность A4 → Риски и границы.
На чём основана документация
Заголовок раздела «На чём основана документация»Документация собрана из спецификаций обоих продуктов и сверена с их исходным кодом. Числа, имена команд и операций, коды отказов и границы возможностей сверяются с кодом при подготовке каждого изменения: если документация разойдётся с продуктом, правка не уходит дальше.
При сборке сайта проверки идут заново — на машине, где исходников продуктов нет. Там сверяется, что страницы совпадают со своим сборщиком, что ни один раздел исходников не потерялся, что все ссылки ведут на существующие страницы и что во внешний текст не попал внутренний материал. Плюс то, для чего исходники не нужны: имена команд сверяются со списком, снятым с самой поставки, а число операций — со списком, снятым с ядра выпуска. Не прошла проверка — не будет и выкладки.
К сравнению с Excel это не относится: оно опирается на официальную документацию Microsoft, и источники названы прямо на странице Карта возможностей рядом с Excel.