Techathon Series: Project Phases - System Design and API Documentation

On Friday the 3rd, we embarked on yet another thrilling journey of delving into the intricacies of project management with our third Techathon.

This time around, we had the pleasure of hosting two presentations on the crucial project phases, system design, and API documentation. Our talented Project Managers, Aida and Rron, left no stone unturned as they imparted important insights into project onboarding and requirements gathering, client communication, and technical documentation.

But that’s not all. To apply the concepts we learned and showcase our abilities in a practical setting, we were given an exciting assignment that will put our skills and knowledge to the test.

Mastering project phases

Led by Aida, we started by exploring the nuances of the various project phases, from initiation to planning to execution, to monitoring and closure.

Aida’s insights were invaluable, as she took us through each of the building blocks of the project phases. In the initiation phase, we learned about onboarding, the client reaching out, and the crucial steps of identifying their needs and outlining the project scope. In the planning phase, we delved into the nitty-gritty of project goals and objectives, deliverables, resources, timelines, and working methodology.

The execution phase was where the real magic happened. With Aida as our guide, we explored the design phase, where the project team creates the UX/UI and software design based on the requirements outlined in the project scope document. The team identifies the necessary components of the software and creates a detailed software design document, which may include diagrams, data models, and other specifications that guide the development of the software. All these specifications are translated into the project's UX/UI, making sure they are aligned and integrated seamlessly. We then moved on to the implementation phase, where we tackled development, testing, deployment, and maintenance.

Aida concluded her presentation by highlighting that meeting client needs is the key to success in any project. She broke down the importance of requirements-gathering and why we at Sogody, place a premium on it.

It is not just about ticking all the boxes on a list - it is about identifying potential issues and risks, avoiding scope creep, and ensuring that project timelines and costs are on track. But that is just the tip of the iceberg. The requirements-gathering process will ensure effective communication between the development team, clients, and stakeholders, provide the basis for testing and quality assurance, and serve as a reference point for future development efforts, helping to ensure consistency and continuity in the software development process.

The importance of client communication and technical documentation

The second part of our Techathon was equally captivating and informative, as Rron took us on the rollercoaster of client communication. As Rron shared from his personal experience, effective communication is critical to building strong client relationships and delivering exceptional results. We discussed the different types of communication and how each could be leveraged to meet specific project requirements.

Rron also shared some valuable insights into the tools that our team members could use, one of which is built by our own team, to enhance their communication skills. He also went the extra mile, sharing some useful tips and tricks he had learned from his extensive experience in the industry.

He continued to share his expertise with us on the importance of technical documentation. In today’s fast-paced world of technology, detailed and accurate documentation is essential for success. Rron went through the types of documentation that are used especially for web development, such as user manuals, API documentation, and architecture diagrams.

To ensure that our team members had the skills and knowledge needed to produce high-quality technical documentation, he showcased a sample diagram, demonstrating that visual documentation is an effective way to communicate complex ideas and processes in a clear and concise manner to all stakeholders.

With Rron's guidance, we learned that effective documentation is critical to the success of any project. It ensures that everyone involved is on the same page and that the project can be completed within the specified timeline and budget.

Rron concluded by highlighting that

Drawing the blueprint

To put our newfound knowledge and skills to the test, our team was given an exciting assignment: to visualize and document a sample e-commerce website implementation.

By utilizing the necessary tools that let us draw the diagrams, or easily describe an API, the team will be able to come up with a comprehensive visualization of a concept project.

With these requirements in mind, our team set to work, drawing upon our creativity, technical expertise, and communication skills. These core principles will serve as a guiding light, helping us to navigate any challenges and deliver exceptional results that will exceed client expectations.