8 best practices for perfect CSS documentation

Click for: original source

Adriana De La Cuadra article about best practices for CSS documentation. In the world of CSS, documentation is underused. Since documentation is not visible to the end user, its value is often overlooked by clients.

Yet documenting CSS can offer a lot to your project: from encouraging better code practices to easing the onboarding of new team members. Sometimes it can be difficult to determine what to document and how to do it most effectively.

Author’s advice revolves around:

  • Settting the ground rules
  • Explaining the structure of your code base
  • Establishing your coding standards
  • Avoiding long stylesheets

… and for the rest click on the link below. The author note, that with these best practices in mind, the next step is to incorporate a living style guide as part of your documentation.

In a living style guide, you can include interactive demonstrations of your code and you can further organize your documentation independently from the code structure. Interesting read!

[Read More]

Tags css frontend web-development miscellaneous