How to use Principles

Your principles.dev profile page

Often we forget or don't have immediate access to what we know, or find it hard to explain what we mean succinctly.

Using Principles.dev, you can capture your favorite principles to remind yourself often of your decision-making process and what you believe.

You could share your Principles.dev profile in many places. Your CV to help find a better team-fit. Or link to it from a blog.

Code reviews

Code reviews become more straightforward and concise. Instead of writing out long comments and explaining why a particular design decision isn't the right choice, you link the principles that will provide the relevant information.

Blog posts

A great way to use principles is to link or attach them to your blog posts.

Your readers can understand where you're coming from without needing to go in-depth in the article, reducing the amount of text you need to write that's not directly related to the article.

Framework or Library documentation

Frameworks and libraries often have implicit principles, making it difficult for users to understand.

Linking to principles in documentation shares understanding rapidly. It can help the users keep those principles in-mind when needing to extend or work with your library or framework.

Capture your decision-making process

Save your decisions in wikis or your code-base to reference when you need.

Capturing principles behind your decision-making process allows you and your team to remind yourself of the why behind your choices. It acts as a guide for current and future decision-making.

Advanced usage

To use understand how to apply principles to your next project, check out Principle Driven Engineering