外部発信(執筆中)

Wantedly Engineering Blog

ウォンテッドリーの開発組織に属するメンバーによる技術ブログです。開発者向け技術情報を中心に発信しています。

目的

社内外でのナレッジの蓄積と共有を目的としています。日々の開発や運用の中で得られた知見や技術的なチャレンジ、その過程と解決方法を以下の点に留意して公開することで、組織全体の技術力向上を目指します。

  • ナレッジの可視化・蓄積

    • 各エンジニアが得た知識や経験をブログとしてストックし、組織内で活用できる形にすることで、全体の生産性を向上させます。

  • 社内外への発信

    • 社内だけでなく、広く社外にも技術的な取り組みや知見を発信し、エンジニアリングコミュニティに貢献します。

  • 技術的な透明性の向上

    • 技術課題に対するアプローチやプロジェクトの進行状況を公開することで、透明性を高め、他チームや外部の関係者との円滑なコミュニケーションを促進します。

手段

技術ブログを効果的に運用し、ナレッジの蓄積と共有を円滑に進めるために、具体的な執筆プロセスやツールの活用方法を定めています。以下に、技術ブログの執筆から公開までの流れを示します。

記事の執筆プロセス

テーマ選定

各エンジニアが直面した技術的な課題や解決方法、または新しい技術導入の成功例や失敗例をもとにテーマを選定します。知識だけでなく、知見も価値あるテーマとなります。

ドラフト作成

記事の骨子をまとめ、詳細な説明や実例を含めた草案を作成します。読者に分かりやすく、再現可能な内容を意識して書くことが推奨されます。レビューを求める場合は、Googleドキュメントを活用することで、フィードバックを受けやすくなります。

レビュー

執筆された記事は、他のエンジニアやプロジェクトメンバーによってレビューされ、技術的な正確さや表現の改善を図ります。

公開

レビューを通過した記事は技術ブログとして公開します。公開された記事は、執筆者自身が責任を持ち、最終的なアウトプットを確認し、表示崩れや不適切な表現がないことをチェックします。

執筆ガイドライン

技術ブログの記事執筆において、読者にとって読みやすく、信頼性のある情報を提供するために、以下のガイドラインに従ってください。技術ブログ以外にも、技術イベントの集客に用いるページ作成にもこのガイドラインを適用します。

文章構成

  • パラグラフを意識した構成

    • １つのテーマやポイントごとに適切な長さのパラグラフを使用し、文章をまとめてください。一般的なブログのような一文ごとの改行や、不要な連続改行は避け、知的かつプロフェッショナルな文体を維持しましょう。

言葉遣い

  • 正式呼称の使用

    • 製品名、サービス名、技術用語など、正式な呼称を使用してください。略語や口語表現は避け、必要な場合には初回に説明を加えた上で使用します。

  • 専門用語の説明

    • 専門的な用語や技術的な概念は、読み手に分かりやすいように説明を加えるか、リンクを提供することで補足してください。特に社外向けの記事では、業界外の読者にも理解できるよう工夫しましょう。

  • 絵文字・顔文字の禁止

    • 文章中で絵文字や顔文字の使用は禁止です。技術ブログでは、内容の正確性とプロフェッショナルな印象を大切にするため、こうしたカジュアルな表現は避けましょう。

  • 「！」や「？」の多様を禁止

    • 感嘆符（「！」）や疑問符（「？」）の過度な使用は避け、文章全体のトーンが落ち着いたものとなるようにします。必要に応じてこれらを使う場合も、1回までの使用に留め、過剰な強調を控えてください。

表記の統一

  • 文体の一貫性

    • 書き手ごとの文体の違いを最小限に抑えるため、敬体（です・ます調）と常体（である調）の混在を避け、一貫した文体を維持します。公開するブログの目的に応じて適切なスタイルを選択してください。

  • 日本語と英語の使い分け

    • 日本語の記事の場合、固有名詞や技術用語などを除き、基本的に日本語を使用してください。必要に応じて英語を併記する場合は、カッコ書きや注釈を使い、読みやすさに配慮します。

スタイル

  • 箇条書きやリストの使用

    • 複数のポイントを示す際は、適切に箇条書きや番号付きリストを使用し、読み手が情報を整理しやすいようにしましょう。

  • 画像やコードブロックの挿入

    • 技術的な内容を視覚的に補足するために、必要に応じて画像やコードブロックを挿入してください。コードブロックは正確であり、適切なハイライトやコメントを含めて、読み手にとって明瞭にすることが求められます。

  • 記事にふさわしいカバー画像の使用

    • 記事の内容を反映した適切なカバー画像を選定してください。読者に対する視覚的なインパクトを考慮し、内容との関連性が明確な画像を用いることが重要です。奇をてらった画像の使用は避け、記事内容に沿った画像を使用してください。

編集と校正

  • レビューを受ける

    • 執筆した記事は、必ず他のメンバーにレビューを依頼し、内容の正確性や表現の適切さを確認してください。

  • フィードバックの反映

    • 受け取ったフィードバックは積極的に反映し、記事を修正・改善してから最終的に公開します。

外部登壇

目的

外部登壇は、技術的な取り組みや知見を広くエンジニアリングコミュニティに共有し、組織の技術的信頼性を高めるための重要な活動です。以下の目的を達成するために外部登壇を推奨します。

  • 技術の普及と共有

    • 社内で培った技術的知見や経験を社外に発信し、エンジニアリングコミュニティ全体に貢献する。

  • ブランド価値の向上

    • 開発組織の技術力を広く認知させ、エンジニア採用やブランド力の向上に繋げる。

  • 個人の成長

    • 登壇を通じて、個々のエンジニアのスキルアップや業界内でのプレゼンスを高める。

手段

外部登壇を効果的に行うため、以下の手段を用いて準備を進めます。

  • ターゲットの明確化

    • 登壇するイベントやカンファレンスの参加者層を明確にし、その対象に合ったテーマや内容を選定します。登壇テーマは、自社の技術的アピールポイントや、コミュニティに有益な情報を軸に決定します。

  • 社内リソースの活用

    • 社内で蓄積された知識や成功事例を活用し、社内メンバーの知見を最大限に活かしたプレゼンテーションを作成します。既存の技術ブログやドキュメントを参考にしながら、最新情報やインサイトを加えて発信します。

  • 定期的な社内練習

    • 社内で登壇内容のリハーサルを行い、フィードバックをもらいながら質を高めます。特に初めて登壇するメンバーには、先輩エンジニアからのアドバイスやサポートを受けることが推奨されます。社内で開催される Tech Lunch や Demo Day を活用ください。

登壇資料の作成プロセス

テーマ選定

登壇先のイベントやカンファレンスの主旨と参加者の興味を考慮し、最も効果的なテーマを選定します。自社の強みを活かし、コミュニティのトレンドに合った内容を選ぶことが重要です。また、日々のプロジェクトにおいて「知見としてまとめたおきたい」と思ったらすぐに資料を作成しストックすることを推奨します。

スライド構成

序盤に資料の目的や習得して欲しいことを明記しましょう。技術力やトピックの重要性を明確に伝えます。各スライドは視覚的に魅力的で、かつ簡潔であることが求められます。箇条書きに頼らずに文章を用いましょう。文字数を減らし、ビジュアルや図をバランスよく挿入すると理解しやすい資料になります。スライド内容はストーリー性を持たせ、最初から最後まで一貫したメッセージを伝えることを意識します。

レビューと練習

スライドが完成したら、社内でのレビューを行います。フィードバックを基に修正を加えた後、練習を通じて内容や時間配分を調整します。

最終確認

最後に、発表資料をチェックし、内容の正確性、表現の適切さ、ビジュアルの一貫性などを確認します。登壇先の主催者やイベント運営者とも最終的な確認を行い、登壇準備を完了します。

ガイドライン

資料のフォーマット

ウォンテッドリー株式会社の一員として登壇する際は、会社指定のフォーマットを使用してください。

技術的正確さ

発表内容は、技術的な正確性を第一に重視します。社内レビューを必ず受け、誤りや誤解を招く表現がないよう注意します。

著作権と引用の遵守

使用する図表やデータには、著作権や使用許諾を確認した上で正しく引用します。必要に応じて出典を明記し、他者の成果物を正しく扱います。

時間配分

発表の時間配分に気を配り、リハーサルを通じて時間内に収める練習を行います。発表時間に余裕を持たせ、Q&Aセッションの準備も整えます。

機微情報やプロダクトに関する数字

社内のPRガイドラインに準拠します。各プロダクトのKPIの具体的な数字や、機密情報やインサイダー情報は掲載禁止です。

登壇資料の公開

個人で SpeakerDeck にアカウントを作成して公開しても良いです。公開する際には、Upload後のフォント表示、URLには注意が必要です。意図した表示かどうか自身で確認してください。

WANTEDLY TECH BOOK

ウォンテッドリーでは、技術書の同人誌イベントである「技術書典」に、社内から有志を募りサークル「Wantedly執筆部」として毎回参加し、WANTEDLY TECH BOOK を作成・頒布しています。 また、ウォンテッドリーが外部カンファレンスに協賛する際にも、スポンサーブースにて WANTEDLY TECH BOOK を頒布することがあります。

WANTEDLY TECH BOOK は、分野や Squad/Chapter を問わず、普段の業務を通して得られた知見を、社内だけでなくコミュニティ全体に還元することで技術に貢献したいというモチベーションから作られています。

過去の TECH BOOK バックナンバー

最新刊を除く過去の TECH BOOK は、以下のリンクからも無料でダウンロードできます。

話を聞きに行きたい

もっと知りたい

前へ効率的な社内知識の調べ方次へApps

最終更新