Технический писатель/Аналитик (PHP/Laravel) - документация проекта

PHP, Техническая документация — неверно указаны категории?

5000 UAH

Проект переведен автоматически. Войдите или зарегистрируйтесь, чтобы увидеть оригинал

Задание:

Провести полный технический аудит и «с нуля» задокументировать архитектуру и логику IT-проекта.

Контекст:

У нас есть несколько активных проектов, над которыми работает небольшая команда (2-3 разработчика). Нам нужно зафиксировать архитектуру и логику системы, чтобы обеспечить стабильность передачи знаний и легкий онбординг новых людей. Проекты связаны с обработкой больших массивов данных.

Технологический стек:

Backend: PHP, Laravel.
Frontend: Vue.js, JavaScript, HTML, CSS.
Database: MySQL / MariaDB (сложные структуры, большие объемы).

Основные этапы работы:

Технический ревью: Ознакомление с кодовой базой (GitHub/GitLab) и интервью с разработчиками для понимания текущей структуры.
Архитектурная документация: Описание High-level архитектуры каждого проекта (компоненты, связи, потоки данных).
Документирование API: Создание актуальных спецификаций (Swagger/OpenAPI или Postman collections).
Инфраструктурная карта: Описание окружения (сервера, базы данных, сервисы, деплой-процессы).
База знаний: Структурирование информации в нашем Notion/Confluence или GitHub Wiki.

Требования:

Опыт документирования программных продуктов от 2-х лет.
Способность самостоятельно читать код на Laravel и Vue.js (чтобы понимать логику без постоянного отвлечения разработчиков).
Умение создавать визуальные схемы (Sequence diagrams, ER-схемы баз данных).
Опыт работы с Markdown и Git.
Умение работать автономно и четко соблюдать дедлайны.

Формат:

Проектная работа

Ставки 6 Отклоненные 1 Обсуждения 2

Андрей М.

6 0

Проекты 5
Оценка 5.0
Рейтинг 908

Бюджет: 10000 UAH Срок: 10 дней

Готов взять на себя полный технический аудит и документирование "с нуля" ваших проектов на Laravel/Vue.

Что сделаю:

Ревью кодовой базы (GitHub/GitLab) + короткие интервью с разработчиками.

High-level архитектура каждого проекта (компоненты, связи, потоки данных).

Актуальная API-документация (OpenAPI/Swagger или Postman collections).

Инфраструктурная карта (сервера, БД, сервисы, деплой/CI/CD, cron/queue).

Визуальные схемы: sequence diagrams, ER-схемы БД.

База знаний в Notion/Confluence или GitHub Wiki (Markdown + Git).

Работаю автономно, соблюдаю дедлайны, документация будет пригодна для быстрого онбординга и передачи знаний в команде.

Рейт 30 у.е. в час.

Анастасія Т.

318 4

Проекты 321
Оценка 5.0
Рейтинг 11 548

Бюджет: 10000 UAH Срок: 20 дней

Здравствуйте, Николай!
У меня есть практический опыт в техническом аудите и системной документации сложных IT-проектов, в частности тех, которые работают с большими объемами данных.
Я хорошо читаю и анализирую код, имею техническое образование, поэтому могу быстро погрузиться в логику без постоянного привлечения разработчиков.

Обращайтесь, обсудим все детали: бизнес-цель проекта, пользовательские роли, сценарии использования и все, что будет полезно для начала работы.

Вячеслав Юдин

7 1

Проекты 6
Оценка -
Рейтинг 410

Бюджет: 4500 UAH Срок: 1 день

Здравствуйте,

Спасибо за подробное описание, буду рад помочь с реализацией проекта. Я инженер по разработке программного обеспечения с более чем 7-летним опытом создания различных веб-сайтов, SaaS-решений, сложных веб-платформ и MVP для стартапов. В портфолио я указал на некоторые разработанные проекты.

Мой стек включает следующие технологии и их фреймворки: PHP (Yii2, Laravel, Symfony), HTML5, CSS3, JS (Vue.js, React.js), MySQL, PostgreSQL.