仕様の文言を揃えたいときにVSCodeの横断検索、一括変換をおすすめしたい

りゅう / 常盤龍司

仕様書を書くときにGitHubを使ったバージョン管理するようにしているのですが、編集エディタとしてVSCodeが優秀で普段使いしていました。

いろんなツールから情報共有されてくるプロジェクトにおいて表現が混在するとエビデンス合意する手間がかかってしまうので便利に使っているのですがTwitterで思ったより反響あったので

メモ程度ですが書いておくことにしました。参考になれば幸いです。

VSCodeって?

Visual Studio Code からダウンロードに進めるコードエディターのことです。

ダウンロードしたら設定とか特にしなくてもすぐ使えるようになります。

横断検索

仕様書を置いているルートディレクトリのフォルダをVSCodeで開きます。

↑補足としてプロジェクトや会社での決め事は全部このフォルダに入れておくと情報の錯綜が半分くらいには減ります。アイデアやメモ程度のものはnotionとかに分けておくと情報の混線がなくてスマートな仕様にまとまります。

画面遷移とか広大な範囲になりそうなものはFigma、シーケンスやERなどの設計図に当たる部分は差分をつけておきたいのでMermaid.jsでコードとして書いておくと後で見返すときに便利です。

重複表現を探す
Mac:Shift + Command F

これでルート直下の全てのファイル、フォルダを一瞬で検索結果として表示してくれます。

全フォルダの一括変換できる方法も見つかりました

横断検索をするとVSCodeの左側にこんな感じで出てきます

同一単語の一括変換

緑で反転してる用語の左にある「>」をクリックすると

すべて置換することができるので

「置換」をクリックするとほぼ一瞬(変更量によるかも)で置き換わります。

実際に使えるシーン

  • ユーザー?User?と和英が混在してるのを名前寄せできる
  • 使っているツールが変わってしまったので名前の一括変換したいのが一瞬
  • 文章をそのままコピーして横断検索すると他のファイルで同じ文章入れている部分がわかるので重複表現が減る
  • SaaSだと検索で画面遷移して編集場所から視線が外れてしまうけどVSCodeなら同じ画面で検索と編集もできるので作業効率が良くなる

この辺りの恩恵があるかと思います。

余談:VSCode→ZenHub+Figmaで全社効率アップ

弊社ではプロジェクト管理にZenHubをつかって非エンジニアでも意図せずGitHubを使えるようになる業務フローに変えています。VSCodeも純粋な編集ツールとして使えるよう組み込むことで会社の承認フローも半自動化していけるようになってきました。これはまた別の機会で。

ZenHubだけでも全社の生産性がかなり上がったのですが、Figmaとも連携させることでディレクション、PMの両面で品質向上できたので、プログラミングできなくとも開発チームの中核で動けるPMを増やしていきたいなと思うところでした。

いいね!
この記事を書いたPM
りゅう / 常盤龍司
@ryuji
  • Twitter
  • コーポレートサイト

美容師からデジタル系7事業を立ち上げエンジニア、講師、ギルド型開発チームの運営等を経て株式会社ユニクシィを設立。現在はDXコンサルティングとしてITビジネスの立案、持続可能なシステム内製化、組織開発を提供している。業務フロー改善が得意。