「アプリは完成したけど、READMEや仕様書を書くのが面倒くさい…」
そんなエンジニアや学生の方の代わりに、ソースコードからドキュメントを生成します!
当方で開発した専用のAIツール(Gemini API等を使用)を活用し、ソースコードの構造を読み取って、マークダウン形式等で分かりやすいドキュメントの「叩き台」を作成します。
【こんな方におすすめ】
就活のポートフォリオ用にREADMEを充実させたい学生の方
個人開発のコードの仕様をテキスト化しておきたい方
ドキュメント作成の「ゼロイチ」の作業をショートカットしたい方
【納品物】
README.md、または仕様書のテキストファイル(マークダウン形式など)
【⚠️ ご注意点(必ずお読みください)】
本サービスはAIを活用して「高品質な叩き台(完成度80%程度)」を作成するものです。システム固有の複雑なビジネスロジックや、細かいニュアンスの最終調整は、お客様ご自身で行っていただくことを前提としております。
大幅なリテイク(やり直し)は原則対応しておりません(明らかなエラー等の場合は1回まで修正対応いたします)。
企業の機密情報が含まれるコードのご依頼はお控えください。個人開発や公開可能なコードを対象としております。
【基本料金(4,000円)で対応可能なコードのボリューム】
スムーズかつ高品質なドキュメント生成のため、1回のご依頼あたり以下の制限を設けさせていただいております。
最大文字数: ソースコード合計 30,000文字 まで
ファイル数: 主要ファイル 7個 まで(目安:トータル1,000行程度)
※上記を超える大規模なリポジトリやシステム全体一括でのドキュメント化をご希望の場合は、事前に「見積もり相談」にてご相談ください(追加オプションにて対応可能です)。
※HTML/CSSなどのデザインコードや、外部ライブラリのコードは文字数カウントから除外していただいて構いません。ロジック部分(Python, JavaScript, Goなど)のみを対象とします。
ご依頼の際は、以下のフォーマットに沿って情報をご提示ください。
ドキュメント化したいソースコード
(ファイルの添付、またはGitHub等のパブリックリポジトリのURL)
コードの主な言語・フレームワーク
(例:Python / FastAPI など)
希望するドキュメントの形式
(例:README用のMarkdown形式、システムの概要仕様書 など)
特に強調して記載してほしいポイント(※もしあればでOKです)
【⚠️ セキュリティと免責事項に関するお願い】
・AIを活用した生成となりますので、100%の完璧な精度を保証するものではありません。「高品質な叩き台」としてご活用ください。
・情報漏洩防止の観点から、企業の機密情報やパスワード等が含まれるコードのご依頼はお断りしております。個人開発などの公開可能なコードのみご提示ください。