Skip to main content

ドキュメントサイト担当になったらやること

前提

  • ドキュメントサイトはあるが、うまく運用できていない状況
  • その中に、ドキュメントサイトの改善にアサインされた
  • 3ヶ月くらいでできると良いな
  • インプット8割、アウトプット2割くらいの割合

やること

  • ドキュメントサイトを読む
    • ページのサイトマップを把握する
    • 記事を10本くらい読む
    • プロジェクトの概要
    • 簡単なチュートリアル
    • リファレンス系
    • FAQはタイトルをざっと眺める(どんな質問が来ているのか?)
  • ドメイン知識を知る
    • 本を読む
    • お客さんの話を聞く
  • サービスを使い倒す
    • 想定ユーザになりきる
    • ドメイン知識を得る(本も読むと良さそう)
    • 使い方不明なところをドキュメントで検索
    • わからないところをメモしておく、が、フィードバックはまだしない(重要)
  • 開発チームの話を聞く
    • プロジェクトの目標
    • 強み弱み
  • CSチームの話を聞く
    • お客さんからどんな声届いている?
    • 多い問い合わせはドキュメントチャンス
  • とりあえず1本書いてみる
    • ここまでやってから書いてみる
    • 現状のスタイルに合わせて書いてみる

やらない方が良いこと

  • サイトリニューアルを提案する
    • 悪いところを治す
  • スタイルガイドをガッチリきめる
    • ちょっとずつなら良さそう