4 links
tagged with all of: best-practices + documentation
Click any tag below to further narrow down your results
Links
The article emphasizes the importance of using examples as documentation in software development. It argues that well-crafted examples can effectively convey concepts and usage more clearly than traditional documentation methods. By providing real-world scenarios, developers can better understand how to implement and utilize software features.
Effective documentation in dbt is essential for enhancing team collaboration, reducing onboarding time, and improving data quality. Best practices include documenting at the column and model levels, integrating documentation into the development workflow, and tailoring content for various audiences. By prioritizing clear and comprehensive documentation, teams can transform their data projects into transparent and understandable systems.
The article provides a comprehensive guide for designers on how to effectively hand off their designs to developers, highlighting best practices, tools, and communication strategies that ensure a smooth transition from design to development. It emphasizes the importance of collaboration and clarity in documentation to facilitate the implementation of design specifications.
Naming components in design systems presents significant challenges due to cognitive load and human psychology, leading to confusion and inefficiencies. The article outlines common naming pitfalls, suggests a systematic approach for effective naming, and emphasizes the importance of clear documentation to enhance understanding and adoption across teams.