toss/technical-writing

技術的な内容を正確かつ効果的に伝えるためのテクニカルライティング完全ガイド

学習教材要確認コーディング支援・CLI エージェントTypeScript難易度
1,1400 保存
50フォーク0Issue
デモ・公式サイトをひらくtechnical-writing.dev

中辛 の解説

技術情報の伝達に特化したライティング手法を学べるガイドです。対象者は開発者やドキュメント作成者で、基本的な文書作成方法から構造設計、AI活用まで段階的に学習できます。インタラクティブなチュートリアル形式で、実践的なスキルが身につきます。

こんなリポジトリです

こんなときに便利です

  • ソフトウェア開発プロジェクトで技術文書やAPIドキュメントを作成するとき
  • チーム内の文章品質を統一し、可読性を高めたいとき
  • AIツールを活用しながら効率的にドキュメントを作成したいとき

主な機能

基本的な文書作成方法の解説複数ページの文書構造設計AIプロンプトを用いた効率的な執筆支援

ほかとの違い

現代のソフトウェア開発に特化した実践的なテクニカルライティング手法を、AIツール活用を含めて体系的に教えています。

このリポジトリの作り方

はじめてですか? むずかしくありません — 上から順にたどれば、自分の環境で動かして味見できます。

ギット飯トライで味見

入れるのが面倒で少し不安だったなら — 安全スキャンからインストールまで、ターミナル一行で終わります。

ターミナルに貼り付ければ、ギット飯の安全スキャン → 隔離フォルダへ clone → インストール → 実行方法の案内まで自動です。はじめてでも大丈夫 — この一行だけです。

npx gitbap-try toss/technical-writing

Node.js さえあれば、インストールなしで動きます · ギット飯トライとは? →

スター推移 · 7日

1,1407日間の増加数を計算するための比較データが不足しています

確認日時

使いやすさ · まねしやすいか

サンプル評点 0/100
  • ゆるいライセンス
  • テストあり
  • サンプル集
  • 最近の更新
  • AGENTS.md
  • llms.txt
  • テンプレート

更新の情報なし · 2025 年に作成

「コーディング支援・CLI エージェント」 こういうリポジトリを毎週受け取りませんか?

毎週月曜の朝、選んだ一膳だけ。広告なし · いつでも解除。

自分のリポジトリですか? README にギット飯バッジを貼る
[![깃밥](https://www.gitbap.com/badge/toss/technical-writing.svg)](https://www.gitbap.com/r/toss/technical-writing)
Claude からそのまま使う — ギット飯のつなぎ方

ギット飯を Claude につなぐと、こうしたリポジトリを Claude・Cursor・Codex から直接さがして試せます。

方法 ① コネクタ URL

Claude の設定 → コネクタにこのアドレスを貼り付け。

https://www.gitbap.com/api/mcp
方法 ② プラグイン(試用まで)

プラグインを入れると /gitbap-trending·/gitbap-try のスラッシュコマンドで、その場でリポジトリを試せます。Claude Code で下の 2 行を順に実行してください。

/plugin marketplace add jakeparkcolde/gitbap-cowork
/plugin install gitbap-cowork@gitbap
つなぎ方をくわしく →

AI が README をもとに要約しました · 原文を見る