Technical Writer/Analyst (PHP/Laravel) - project documentation

PHP, Technical Documentation — incorrectly specified categories?

112 USD

Project translated automatically. Log in or register, to view the original

Task:

Conduct a complete technical audit and document the architecture and logic of the IT project from scratch.

Context:

We have several active projects that a small team (2-3 developers) is working on. We need to document the architecture and logic of the system to ensure stable knowledge transfer and easy onboarding of new people. The projects are related to processing large data sets.

Technology stack:

Backend: PHP, Laravel.
Frontend: Vue.js, JavaScript, HTML, CSS.
Database: MySQL / MariaDB (complex structures, large volumes).

Main work stages:

Technical review: Familiarization with the codebase (GitHub/GitLab) and interviews with developers to understand the current structure.
Architectural documentation: Description of the high-level architecture of each project (components, connections, data flows).
API documentation: Creation of up-to-date specifications (Swagger/OpenAPI or Postman collections).
Infrastructure map: Description of the environment (servers, databases, services, deployment processes).
Knowledge base: Structuring information in our Notion/Confluence or GitHub Wiki.

Requirements:

Experience in documenting software products for at least 2 years.
Ability to independently read code in Laravel and Vue.js (to understand the logic without constantly distracting developers).
Ability to create visual diagrams (Sequence diagrams, ER diagrams of databases).
Experience working with Markdown and Git.
Ability to work autonomously and adhere to deadlines.

Format:

Project work

Proposals 6 Rejected 1 Discussions 2

Andrey M.

6 0

Budget: 10000 UAH Deadline: 10 days

Ready to take on a full technical audit and documentation "from scratch" of your projects on Laravel/Vue.

What I will do:

Review the codebase (GitHub/GitLab) + short interviews with developers.

High-level architecture of each project (components, connections, data flows).

Current API documentation (OpenAPI/Swagger or Postman collections).

Infrastructure map (servers, databases, services, deployment/CI/CD, cron/queue).

Visual diagrams: sequence diagrams, ER diagrams of databases.

Knowledge base in Notion/Confluence or GitHub Wiki (Markdown + Git).

I work independently, meet deadlines, and the documentation will be suitable for quick onboarding and knowledge transfer within the team.

Rate 30 currency units per hour.

Anastasiia T.

318 4

Budget: 10000 UAH Deadline: 20 days

Hello, Mykola!
I have practical experience in technical auditing and system documentation of complex IT projects, particularly those that work with large volumes of data.
I read and analyze code well, have a technical education, so I can quickly immerse myself in the logic without constant involvement of developers.

Feel free to reach out, we will discuss all the details: the business goal of the project, user roles, use cases, and everything that will be useful to start working.

Vyacheslav Yudin

7 1

Projects 6
Rating -
Rating 410

Budget: 4500 UAH Deadline: 1 day

Hello,

Thank you for the detailed description, I will be happy to help with the implementation of the project. I am a Software Development Engineer with more than 7 years of experience in creating various websites, SaaS solutions, complex web platforms, and MVPs for startups. In my portfolio, I have highlighted some developed projects.

My stack includes the following technologies and their frameworks: PHP (Yii2, Laravel, Symfony), HTML5, CSS3, JS (Vue.js, React.js), MySQL, PostgreSQL.