Mindful documentation for (web) components and frameworks

Many individuals and teams fail at documenting their projects properly, effectively drawing other developers away from their code. Fortunately, the most common documentation pitfalls are quite simple to overcome. In this article, I’m going through techniques that have helped make our projects more approachable to new developers whilst also appealing to power users, eventually bringing more people

[efcl]

ドキュメント英語。 "You can"や"if required"などの文章じゃなくて短く書くこと、どういう順序でユーザの疑問に答えていくか、トラブルシューティングの書き方、変な仮定を書かない