Helpfeelテクニカルライティングの納品前チェック:概要編
このページは「概要編」です。
詳細編は→Helpfeelテクニカルライティングの納品前チェック
概要
テクニカルライターはライティングを終えたら、納品前チェックを行う。
大きく分けて以下2つの観点でチェックする。
記事部分(タイトル、本文)
質問文(および、そこから作られる「言葉のヒント」)
この作業のために、2種類のjsonファイルを作る
記事部分のチェック → scrapbox.jsonを使う
該当Scrapboxの[Project settings]からscrapbox.jsonを作る (該当プロジェクトのadmin権限必要)
Report whole FAQsで .xlsxファイルに変換する
.xlsxファイルから本文部分を取り出して、各種検証に使う
/Helpfeel4Helpfeel/ページ本文を校正ツールでチェックする
質問文のチェック →helpdata.jsonを使う
該当Helpfeelの
https://helpfeel.com/{PROJECTNAME}/data/helpdata.json
から helpdata.json を作る CSVファイルに変換する /Helpfeel4Helpfeel/質問文(言い換え表現)をファイル出力してチェックする#5f8e82e06754400000e25968
Shift-JISにエンコードする
Excelまたはスプレッドシート等で開き、質問文の部分を取り出して各種検証に使う
参考:
Helpfeelテクニカルライティングの納品前チェック#61df85de44cd5d00008c107c
helpdata.jsonとの向き合い方(準備編)
helpdata.jsonとの向き合い方(本番編)