Markdown×GitHubでエンジニア工数を削減し、開発集中環境を実現
スタートアップのGen-AX株式会社は、プロダクト立ち上げ時にドキュメント整備が不十分で、エンジニアがマニュアル作成に割かれていた。Markdown形式とGitHub、VitePressを組み合わせたWebマニュアル制作と自動デプロイ仕組みを導入することで、エンジニアの負担を大幅に軽減し、開発業務への集中が可能になった。
- 導入企業
- Gen-AX株式会社
- 業種
- IT・ソフトウェア
- 規模
- スタートアップ企業（約1年の立ち上げ段階）
- 部門
- プロダクト企画部
- 解決した製品
- Markdown×GitHub×VitePressによるWebマニュアル制作ソリューション（science.co.jp）
- マニュアルの種類
- ユーザー向けと管理者向けの2種類
01課題
立ち上がったばかりのスタートアップで、ドキュメント作成ツールや環境が整備されていなかった。プロダクト立ち上げを急ぐ必要がある中で、エンジニアがマニュアル作成に割かれており、また統一感のあるマニュアル制作に必要な専門知識やノウハウが不足していた。
02やったこと
Markdown形式による操作マニュアル原稿作成、VitePressを用いたWeb化仕組みの構築、GitHubとAzureを活用したマニュアル管理環境の構築を実施。デプロイ作業の自動化により、エンジニアへの依頼が不要になる仕組みを構築した。
03成果
エンジニアがデプロイをお願いするコミュニケーションが不要となり、プロダクト開発に集中できる環境が整った。Markdownとテンプレートの採用により、執筆者はデザインを気にせず文章作成と画像配置に集中できるように。GitHubによる一元管理で更新履歴が明確に記録され、リバートやデプロイ漏れ防止も容易になった。
本ページは掲載元の公開事例の要約です。詳細・一次情報は出典元をご確認ください。 掲載内容の修正・削除のご依頼はこちらの窓口へ。
この事例に興味があるなら
似た悩み・別の解き方の事例を、おすすめの理由つきで。
属人的な開発業務をマニュアル化、4日間の合宿で約8割のマニュアルを完成
約8割同じコンサル・支援の中でマニュアル作成セミナー・マニュアル作成支援を選んだ会社の、選定の比較材料になる1本。
テクニカルライター常駐によるマニュアル品質向上で、ゲーム開発効率化を実現
同じコンサル・支援の中でマニュアル作成代行サービスを選んだ会社の、選定の比較材料になる1本。
ひとり情シスの属人化リスクを解決、システム安定稼働を実現
同じコンサル・支援の中で情シスSAMURAIを選んだ会社の、選定の比較材料になる1本。
授乳室mamaro®の全国展開を支える保守体制をNECフィールディングの保守アウトソーシングで構築
同じコンサル・支援の中でNECフィールディング 保守アウトソーシング…を選んだ会社の、選定の比較材料になる1本。
属人的な社内システムマニュアルを体系的に整備し、利用者の理解定着を実現
同じ「手順書がない」を、業務マニュアル作成サービス・操作マニュアル作…という別の入口から解いた1本。