Development Practices What Makes Good API Documentation? API documentation can turn integrating a service from a three-day endeavor to a 10-plus-day endeavor depending on its quality.
Development Practices How to Use C4 Diagrams in Systems Architecture My team recently used C4 diagrams to represent software systems. The standardized diagramming language creates a level playing field for all.
Developer Tools Use Obsidian for Complex Entity Documentation Adding Obsidian to a recent software project created a coherent visual model the team could use for both reference and knowledge transfer.
Development Practices Avoid These 3 Things When Working with Microservices Microservices architecture promises numerous benefits: scalability, flexibility, and quicker deployments. Yet, navigating can be challenging.
Development Practices Leverage Built-in Features: A Lesson in Simplicity I recently wondered if built-in features could simplify implementation in my software project. And sure enough, my hunch proved correct.
Azure Use These Credentials to Deploy from GitHub Actions to Azure Error handling to pass credentials for Azure/functions-action@v1. This action allows you to deploy an Azure Function App from GitHub Actions.
Project & Team Management Project Documentation: Use Headers as an Outlining Tool Using this process, project documentation will feel like a breeze and the resulting documents will have much higher levels of readability.
Development Practices The Value of Writing About Bugs A good bug-fix story has a lot of value. I want to explain why I think developers should spend more time writing about bugs.
Development Practices Keep Your Documentation Up to Date with a Checklist I've recently utilized a Documentation Checklist to help keep my software documentation up-to-date while saving time and effort.
Effective communication Building a Generalist Marketing Team: The Case for Documentation When building a generalist marketing team, documenting your tasks pays dividends long-term, from onboarding to switching tasks.
Effective communication Expedite Development with Minimum Project Documentation Something that helps expedite development is having the minimum amount of project documentation at the right level of detail.
Development Practices 5 Types of Software Documentation & Tips to Manage Each Today, I'll cover five different types of documentation in software development, with tips on how to use them as effectively as possible.
