本文へスキップ
BigTree108

テクニカルライティングサービス

ソフトウェア企業向けのテクニカルライティングサービス：APIリファレンス、開発者ガイド、ユーザー向けドキュメント、ランブック、リリースノートを、プロダクトの隣にコードとして書き、リリースごとに最新に保ちます。

テクニカルライターの担当業務

  • APIドキュメント

    OpenAPIまたはGraphQLのスキーマから生成するリファレンスと、その周りに書く導入ガイド、認証の手順、実行できるサンプルにより、リファレンスは手で編集しません。

  • Docs as Code

    ドキュメントを御社のリポジトリのMarkdownで管理し、コードと同じようにプルリクエストでレビューし、プロダクトと同じパイプラインでDocusaurus、Starlight、同様のジェネレーターで公開します。

  • ユーザーガイドとヘルプセンター

    読者が何をしようとしているかで整理したタスクベースのガイドとヘルプセンターの記事を、Diátaxisフレームワークに沿って、チュートリアル、ハウツーガイド、リファレンス、解説に分けます。

  • ランブックと運用ガイド

    デプロイ、リストア、インシデント対応、オンコールの手順書を、書いていない人が実際に試してテストします。

  • リリースノートと変更履歴

    ユーザーにとって何が変わったかを伝えるリリースノートと、連携を行う側向けの変更履歴を、マージ済みのプルリクエストから下書きし、リリースと照合して確認します。

  • スタイルと品質のチェック

    スタイルガイドと用語集をパイプライン上のValeで自動チェックし、ビルドのたびにリンク切れも確認します。そのため、品質の一貫性が特定のレビュアーに左右されません。

テクニカルライターを採用する

  • 御社チームにフルタイムで参画

    御社の稼働時間に合わせ、御社のツールと会議の中で働き、御社のリードに報告するテクニカルライターです。ウクライナでの雇用契約、給与支払い、休暇管理は当社が担います。

  • パートタイム・部分稼働

    業務は確かにあるものの、まだフルタイムの職務にはならない場合に、週の稼働日数を決めてテクニカルライターが参画します。

  • プロジェクトやローンチ向け

    最初の1週目から引き継ぎまでの一定期間を担当するテクニカルライターです。終了日は事前に取り決めます。

スペシャリストが御社のチームに参画する方法は専任チームのページで、プロジェクトのデリバリー、引き継ぎ、料金の考え方はアウトソーシングのページで説明しています。

テクニカルライターの連携先

  • エンジニアとテクニカルリード

    インタビュー、レビュー、技術的な正確性の確認

  • プロダクトマネージャー

    機能、対象読者、リリース範囲

  • サポートエンジニア

    ユーザーが実際に寄せる質問

  • UI・UXデザイナー

    インターフェース上の文言と図

テクニカルライターの進め方

ドキュメントはコードと同じ場所、つまりリポジトリで管理します。説明対象の変更と同じプルリクエストでレビューし、パイプラインでビルドして公開します。ドキュメントがマージされて初めて機能は完了となるため、ドキュメントはコードと同じ鮮度に保たれます。

執筆は読者から始めます。読者は誰で、何をしようとしていて、何をすでに知っているのか。サポートチケットや検索キーワードから現行ドキュメントの不備が分かるため、該当するページから優先して修正します。

その他の対応職種

チームの役割の概要

テクニカルライターの採用に関するご質問

誰もドキュメント化していないシステムを、テクニカルライターは文書化できますか。

はい。ライターがコードと設定を読み、エンジニアにインタビューして、アーキテクチャ概要、運用手順書（ランブック）、用語集を作成します。内容はシステムを運用する担当者がレビューします。既存システムを引き継ぐ際にも、当社はまず同じ読み取り専用の調査から始めます。

APIドキュメントをAPIの変更に合わせて最新に保つには、どうしていますか。

リファレンスはビルド時にOpenAPIまたはGraphQLのスキーマから生成するため、APIとずれることはありません。ライターは、生成ツールでは作れない部分を補います。クイックスタートガイド、認証の手順解説、そしてリファレンスが役立つ前に開発者が必要とするサンプルです。

テクニカルライターは、どのくらいで開始できますか。

適任のテクニカルライターがすぐに対応可能な場合、開始までの条件は、御社の面接と、NDAおよび知的財産権の譲渡契約の締結のみです。そうでない場合は人材を探索し、通常は2〜3週間以内に候補者のプロフィールをお出しします。御社が承諾するまで、誰も業務を始めません。

BigTree108を通じてテクニカルライターを採用するには、どうすればよいですか。

必要な業務内容、シニアリティ、稼働時間をお知らせください。1〜2名の候補者をプロフィールとともにご提案し、御社が自社で採用する場合と同じ形で面接を行います。契約はBIG TREE 108 LLCとの1本、請求書は月1通です。

成果物の権利は、誰に帰属しますか。

御社です。すべてのスペシャリストはBigTree108と署名済みの契約を結び、成果物のすべてを会社に帰属させています。さらに、御社との契約により、その権利は御社に引き継がれます。コード、デザイン、ドキュメントは、当社だけが変更できる場所ではなく、御社のリポジトリとツールに納品します。

ドキュメントが製品に追いついていませんか。

製品、読者、現在のドキュメントの置き場所をお知らせください。1営業日以内に、候補者のプロフィールまたはドキュメント整備計画をご回答します。

hello@bigtree108.comにメールする対応の流れ