Skip to content

Commit

Permalink
update:technicalwriting
Browse files Browse the repository at this point in the history
  • Loading branch information
KoushiKagawa committed Aug 17, 2023
1 parent bc6b78e commit 32fc62c
Show file tree
Hide file tree
Showing 2 changed files with 70 additions and 0 deletions.
66 changes: 66 additions & 0 deletions about/technicalwriting.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
# テクニカルライティング

2020〜はドキュメントサイトのPMとして活動しています。
ドキュメントはプロダクトをサポートする重要なコンテンツだと思っています。プロダクトの魅力を利用者に伝えられるよう、分かりやすく丁寧な文章の作成を心がけています。

## 対応業務

- マネジメント業務
- タスク管理
- 優先順位設定
- タスクアサイン
- Dueの設定
- チーム運営
- ミーティングファシリテーション
- 他部署との連携
- 情報収集
- ガイドライン運営
- ガイドライン作成
- ガイドライン周知
- ツール運営
- 利用ツール選定
- ツール利用方法レクチャー
- テクニカルライティング
- ドキュメント作成
- チュートリアル
- リファレンス
- FAQ
- レビュー対応
- リリースノート作成
- UXライティング
- UI文言作成

## 実績
### [Kurocoドキュメント](https://kuroco.app/ja/docs/)

株式会社ディバータが制作・運営しているヘッドレスCMS「Kuroco(クロコ)」の開発者向けドキュメントサイトのプロジェクトマネジメントを担当しました。

ドキュメントサイトとしてどのようなページ構成が必要か、どのようなコンテンツが必要かから調査し、設計、コンテンツ作成を行ないました。
また、社内にライティングチームがない状態なので、サポートや開発チームのメンバーにライティングナレッジを共有し、各メンバーがドキュメントを書けるようにサポートしました。

#### 役割

- プロジェクトマネジメント
- 要件定義
- 設計
- 課題整理
- タスク管理
- チーム運営
- テクニカルライティング
- スタイルガイド構築
- コンテンツ作成

#### 進め方

ドキュメントサイトを構築するにあたり知識が不足していたので、他社の事例を確認、ウェビナーに参加し意見を聞く、本をひたすら読む、などをして情報を得ました。
また、代表からプロダクトの思いやロードマップについて確認し、その思いから必要なコンテンツを洗い出していく過程を取りました。

社内外から情報を得ることで、一般的なドキュメントサイトはどのような構成なのかを下地にしつつ、社内として表現したい内容をコンテンツに落とし込むことができました。
さらに、自分が得た情報は社内ドキュメントとして作成し、各メンバーへのナレッジ共有も行いました。

#### メンバーとのコミュニケーションについて

リモートワークの参加だったので、コミュニケーションにより注力しました。
メンバーと良い關係を築くよう、プロジェクト初期は頻繁に1on1にてコミュニケーションをとるようにし、相談やレビューをしやすい状態を作りました。

また、毎日2時間常にmeetをつなぎ、誰でも自由に入って来れるように設定し、疑問点はすぐに聞ける環境を作りました。 その結果、こまめに同期相談ができるようになり、ドキュメントのコミット数が多くなりました。
4 changes: 4 additions & 0 deletions index.md
Original file line number Diff line number Diff line change
Expand Up @@ -183,6 +183,10 @@ Web制作のビジネスにおいて必要な一連のスキルを網羅的に

詳細な実績は、[プロジェクトマネジメント](/about/projectmanagement)をご確認ください。

### テクニカルライティングスキル

詳細な実績は、[テクニカルライティング](/about/technicalwriting)をご確認ください。

### プログラミングスキル

<img alt="php" src="https://img.shields.io/badge/-Php-777BB4.svg?logo=php&style=flat-square" />
Expand Down

0 comments on commit 32fc62c

Please sign in to comment.