Documentation-Portfolio
Documentation Portfolio
Hi, I am Sayanta Banerjee. This page contains a proof of my work on documentation and a non-comprehensive list of articles proudly written by me. Find my certifications here. Badges at Credly can be found here.
API Documentation
- Python API - Generated mock API documentation for the Python Math API. Check it out from Sphinx-Mock-API-Documentation.
- REST API - Documentation for a mock weather API.
- Documented REST and Python APIs for Nirmata, Syself, and Keysight products (API docs are not available publicly).
Product Documentation
Below are some of the product documentation, where I have played a major role in contributing to the existing documentation and overhauling the entire documentation.
- Nirmata Documentation
- Keysight ADS Documentation (P.S. - This doc is not publicly available as it is only given to active Keysight ADS users. Hence, you can look at one sample product doc and one sample process doc)
- SAWO Labs Documentation
- Syself Documentation
- Mattermost Documentation
- Kubernetes Documentation
- Civo Documentation
Articles
The latest blog posts and articles are listed below:
- Top API Design Trends to Watch Out for 2025
- Unpacking LangChain: All You Need to Know to Get Started
- The ultimate crash course on OpenAI APIs: A beginner’s handbook
- LangChain 101: An in-depth understanding of AI development with the framework
- 8 steps to create a successful cloud strategy / Signoz
- Kubernetes 101: A comprehensive guide
- Kubernetes vs Docker: A comprehensive comparison / Civo
- Choosing the right cloud provider / Civo
- Leveraging WebAssembly for improved performance in Kubernetes / Civo
- Networking 101 - IP Packets explained (Co-Written with Kai Hoffman) / Civo
- Authenticated PDF to Doc Converter with Auth0 and Cloudinary
- Data modelling with Statype / Statype
- An introduction to Talos Linux: The new Kubernetes Operating System / Civo
- Scaling your application on Civo Platform, a PaaS solution / Civo
- Strategies to optimize your cloud costs / Civo
- A comprehensive guide to cloud cost management / Civo
- Getting started with Nginx Ingress Controller / Civo
- Your guide to Kubernetes dashboards / Civo
- Edge computing explained / Civo
- Trending topics at KubeCon NA 2022 / Civo
- Kubernetes and cloud-native glossary / Civo
- Kubernetes interview questions for advanced learners / Civo
- Build and test your code with a CI pipeline / Civo
- Understanding Civo K3s with simplicity / Civo
- Kubernetes vs Docker: A difference that matters / In-depth analysis
- Everything you need to know about K3s / Mattermost
- Create an Authenticated PDF converter / In-depth analysis
- Trusted device authentication 101 / Mattermost
- Five tools to increase Kubernetes developer productivity / Civo
- Installing minikube as a Kubernetes cluster / In-depth tutorial
- Cursor chat integration with presencejs / In-depth tutorial
- Understanding monitoring and observability / Civo
- Evaluating data solutions for large-scale applications / Civo
- Everything you need to know about CFPs / Civo
- Everything you need to know about cloud-native / Civo
- DevOps 101: All you need to know / Civo
- What’s new in Kubernetes v1.25? / In-depth analysis - Civo
- All you need to know about Internal Developer Platforms and architecting one with Backstage and Humanitec / Humanitec
- Kubernetes interview questions for beginners / Civo
Glossaries
The Civo Kubernetes and Cloud-native glossary is out now. Check it out from Kubernetes and Cloud-Native A-Z Guide.
Newsletters
- Written 52 Dev-Catch-Up issues for DevShorts.
Content Strategy and Information Architecture
Case Study: To create the information architecture and content strategy for a fictional company named Protekt and use a static site generator to show the created documentation structure.
Work Done: I created the documentation structure in accordance with the developer journey and used Mkdocs with Material theme as the static site generator. Since, this is a documentation which is catering mostly to developers, I structured the documentation in lieu of that. Although, some non-technical product managers can also access the documentation. Hence, the idea of putting references and concepts took place. I have added glimpses on how a person can navigate through the documentation. Alongside, I have mock-documented the introductory prose and a feature tutorial that shows the usage of Protekt’s feature-specific SDK with multiple coding languages and frameworks. Furthermore, I hosted the documentation with the help of GitHub workflows.
- Protekt Documentation Plan: Check out Protekt Documentation Plan.
- Protekt Documentation: Check out Protekt Documentation.
Client Testimonials
E-Books
Coming Soon……
Upcoming articles:
- A step-by-step guide: Moving Your Applications to Kubernetes
- PaaS vs IaaS vs SaaS: Understanding the difference
- The ultimate guide to Kubernetes security: Best practices and tips
- Migrating your database to Civo: A developer’s guide
- Integrating Weavy with a simple application
- Laundry list of AI Coding Copilots
Drop me a line to catch up with me, if you want me to write for your organization or publication.