タグ

docとdjangoに関するmasterqのブックマーク (1)

  • よい製品でもガイドやチュートリアルが難解だと使ってもらえない、ではドキュメントの正しい作成方法とは?

    どんなに優れた製品でも、その製品のドキュメントが難解だとユーザーの拡大は難しいもの。そんなドキュメントの「正しい作成方法」について、ウェブアプリのビルドサービスを提供するDivioが解説しています。 The documentation system — Documentation system documentation https://documentation.divio.com/ よい製品でもよいドキュメントがなければユーザーは増えないと多くの人が認識しているにもかかわらず、「正しいドキュメント作成方法」を知らないために、ドキュメント作成に失敗している事例が後を絶たないとDivioは指摘。Divioはドキュメントを「実践的か、理論的か」「学習時に役立つか、作業時に役立つか」の2軸に当てはめ、「チュートリアル」「HowToガイド」「リファレンス」「説明・議論」の4つに分類しています。

    よい製品でもガイドやチュートリアルが難解だと使ってもらえない、ではドキュメントの正しい作成方法とは?
    masterq
    masterq 2021/02/05
    "「チュートリアル」「HowToガイド」「リファレンス」「説明・議論」"
  • 1