【こんな方におすすめ】
・GitHubに載せるREADMEを作りたい
・自作ツールやサービスの使い方を分かりやすくまとめたい
・メモや説明が複数のファイルに散らばっている
・自分では分かるけれど、他の人には説明しづらい状態になっている
・操作方法や作業手順を簡単なマニュアルにしたい
・引継ぎ用の資料を整理したい
・既存のREADMEやマニュアルが読みにくくなっている
・大量の文章を「必要な情報が探しやすい資料」に整理したい
既存のメモ・仕様・説明文・操作手順などを確認し、READMEや簡易マニュアル、手順書などの形に整理します。
「情報は揃っているけれど、どんな順番で説明すればいいかわからない」「自分では使い方が分かるけれど、他の人へ説明できる資料になっていない」といった、情報整理・文書作成に対応します。
単純に文章を書き直すだけではなく、資料を実際に読む人を想定し、見出し構成、情報の順序、重複、説明不足になっている箇所などを確認しながら整理します。
GitHub等で使用するREADMEのほか、簡単な操作マニュアル、作業手順書、サービス説明資料、引継ぎ資料などにも対応可能です。
【対応例】
・GitHub用README
・ツールやアプリの簡易説明書
・サービス利用方法
・操作手順書
・作業マニュアル
・業務フローの文章整理
・引継ぎ資料
・既存マニュアルの再整理
・複数のメモや資料から1つの説明資料を作成
・よくある質問(FAQ)の整理
【基本料金で対応する内容】
・資料、メモ等の確認
・情報の分類、整理
・見出し構成の作成
・文章のリライト、説明の整理
・READMEまたは簡易マニュアル等の作成
・5,000字程度まで
・元資料5ファイル程度まで
・納品形式:Word(.docx)またはMarkdown(.md)
・修正2回まで
※内容や資料量によって料金が変わる場合があります。大量の資料、複数種類のマニュアル作成などをご希望の場合は、購入前に別途オプション選択か、ご相談ください。
【READMEについて】
GitHub等で公開するREADMEでは、ご提供いただいた情報をもとに、
・概要
・主な機能
・使用方法
・導入方法
・ファイル構成
・注意事項
・ライセンスや関連情報など、必要な項目を整理します。
すべての項目を必ず入れるのではなく、プロジェクトの内容や公開目的に合わせて必要な情報を選びます。
プログラムそのものの開発や動作保証ではなく、既存の情報を第三者にも理解しやすい文書へ整理するサービスです。
【情報の取り扱いについて】
ご提供いただいた資料に記載されている内容を基本として整理します。
技術仕様やサービス内容について、確認できない情報を推測して事実として追加することはありません。不明点や資料間で内容が食い違っている箇所がある場合は、必要に応じて確認させていただきます。
パスワード、APIキー、アクセストークン、Cookie等の認証情報はお送りにならないようお願いいたします。
【対応できないもの】
・プログラムやシステムそのものの開発
・コードの動作保証、デバッグを主目的とする作業
・専門資格を必要とする業務マニュアルの監修
・提供されていない仕様の推測による補完
・虚偽の機能、実績等を記載する資料作成
・第三者の著作物を無断転載する資料作成
・パスワードやAPIキー等の認証情報を扱う作業
・違法、不正行為を目的とした資料作成
ご購入後、以下の内容をお送りください。
・作成したいもの(README、操作手順書、簡易マニュアル等)
・資料を読む予定の人(一般利用者、社内スタッフ、開発者等)
・資料を使用する場所(GitHub、社内共有、Webサイト等)
・整理したい元資料
・必ず掲載したい内容
・希望する納品形式(Word/Markdown)
・希望納期
「何を掲載すればいいかわからない」という場合は、現在お持ちの資料と、何のために使用する資料なのかをお知らせください。内容を確認し、必要な構成から整理します。
既存のREADMEやマニュアルを改善したい場合は、そのファイルもお送りください。
機密情報、個人情報、パスワード、APIキー、アクセストークン等、作業に不要な重要情報は送付しないようお願いいたします。必要に応じて伏字や削除をした状態で資料をご提供ください。
資料量が多い場合や、複数のマニュアルをまとめて作成する場合は、基本料金の範囲を超える可能性があります。判断が難しい場合は、購入前にメッセージからご相談ください。