A one-page questionnaire to help your team establish effective frontend guidelines, so that you can write consistent & cohesive code together.
HTML
HTML Principles
What are some general principles your team should follow when writing HTML?(for example, authoring semantic HTML5 markup, accessibility, etc. See theseresources for inspiration)
HTML Tools
Are you using an HTML preprocessor(such as HAML, Pug, etc)?
Does your backend architecture influence the frontend markup in any way (for example, WordPress will add wp-paginate to a class in your markup)? If so, can you highlight these conventions?
HTML Style
Spaces or Tabs?
What does HTML commenting look like?
CSS
CSS Principles
What are some general principles your team should follow when writing CSS?(For example, modularity, avoiding long selector strings, etc. See theseresourcesforinspiration)
CSS Methodology
Is your team using a CSS methodology(such as SMACSS, BEM, or OOCSS)? If yes, where is the documentation for that methodology?
Are you deviating from the methodology in any way? If so, can you highlight these conventions?
CSS Tools
Is the team using a preprocessor(such as Sass or Less)?
What are the guidelines for using that preprocessor(check out Sass Guidelines for inspiration)?
Who's responsible for managing and governing the version controlled code??
Where are issues tracked?
Support and Optimization
It's important to recognize the difference between "support" and "optimization". You should do your best to support as many environments as possible while simultaneously optimizing for the environments that make the most sense for your business and users.
Where does your documentation live? What are the links to the documentation?
Who's responsible for maintaining and governing the documentation?
What happens when the guidelines are updated?
Feel free to modify or extend (such as adding specific sections for performance, accessibility, etc) this document for your own organization's needs. For questions, comments, additions, and corrections, please open an issue on Github and/or reach out to @brad_frost on Twitter.
请发表评论