How to Document My First AWS Project for a Portfolio?

Consider exploring AWS tools for automating parts of your documentation. Using CloudFormation or CDK can help you create a templated approach to documenting your architecture as code. Be sure to upload this to a public GitHub repo along with your diagrams and a solid README. A video demo can also make your portfolio stand out!

Great stack you built there! For documentation, start with an architecture diagram—something like draw.io or Lucidchart can help you visualize how everything connects. After that, write a case study that explains the project’s purpose, the AWS services you've used, and any challenges you tackled during development. Don't forget to capture screenshots of your AWS management console configurations before shutting anything down, as well as any demo visuals or logs.

If you're looking to generate a nice infrastructure diagram, tools like draw.io are user-friendly and free. For documentation, writing a blog post could really help—it's a great way to detail your process and showcase your stack and logic. Additionally, consider using Infrastructure as Code to create templates for your setup, which can also make the documentation process smoother.

Congrats on getting your project up and running! To document it well for your portfolio, I suggest creating two main diagrams: a runtime dependency diagram and a deploy-time dependency diagram. The runtime diagram should show how services like Lambda and API Gateway interact, while the deploy-time diagram can outline which code from GitHub corresponds to each Lambda function. Alongside these, it’s helpful to include several sequence diagrams that illustrate the most important flows of your application. A couple of paragraphs explaining what’s going on in each diagram can make it easier for viewers to understand the architecture.