きゃらりこ日誌

2020年08月

サイト管理 / 技術

マニュアルの執筆って大変

350ml.net史上、最大(?)の力作「ショートカットApp アクションリファレンス」を、今月の頭に公開しました。
これはiOSアプリ「ショートカットApp」のアクションをまとめた、おそらく世界で唯一のアクションリファレンスマニュアルです。
公式のマニュアルとして「ショートカット ユーザガイド」がすでにあるのですが、そこに書かれていないことがあまりにも多すぎて、全然頼りにならなかったので自分書くことにしました。
去年11月末から書き始め、当初の見立てでは3か月ぐらいかなと思って気楽に始めたのに、途中から書籍化できるクオリティを目指してしまったがために9か月もかかってしまいました。
執筆途中で、iOSやアプリの仕様・内部動作についての解説を書かなければ理解できないのでは?と気づき、そのために追加検証をする羽目に。
しかも執筆中、この秋にはiOS 14がリリースされることが発表されて焦りましたが、なんとかiOS 14のリリース前に書き上げました。

ショートカットApp アクションリファレンス

今までマニュアルのたぐいを書いたことがなかったのですが、マニュアルの執筆の大変さがよくわかりました。
特に書籍クオリティを目指したので、分かりやすさはもとより、言い回し・用語の統一にも気を使う必要があり大変でした。
マニュアルの統一感を出したうえで執筆を楽にするには、文章のスタイルマニュアルと、定型フレーズ集・用語集を事前に用意しておくのがポイントです。
これを作りながら、同時に書き進めていったら、中盤からはぐっと楽になりました。

しかし執筆の一番の難敵は、飽きでした。
このせいで公開予定がどんどん遅れていくのも困りましたが、しばらく間が空くと文体がちょっと変わってしまうのも困りました。
ただ今まで書いたものを校正することで文体を思い出すことができ、細かいところはスタイルマニュアル・定型フレーズ集・用語集を読み返すことで解決できました。

最後に何度も校正作業を行い、全体的に文体・観点が同じになるように直したのですが、これもまた大変でした。
最終校正で大ミスに気がつき、一括置換したらおかしくなったので、もう一度再チェックする羽目になったり…
公開後も細かいミスを見つけたら直していますが、今になってあれも書いたほうが良かったかも…なんて心が揺れています。
iOS 14のパブリックベータ版を使っている人のうわさによると、新しい機能が追加されていたり不具合が見つかっているようなので、改訂版を出すときにはアクションの動作の検証からやり直さないといけないですね。
厄介だなぁ。
[ | この記事のURL ]