Intro OpenAI の API を用いて、長年の課題だった文書校正を VSCode 上で実現するプラグインを修作したところ、思った以上の成果だった。 文章校正と誤字脱字検出 執筆を補助するツールは多々開発されているが、基本は形態素解析を用いた品詞分析の延長で行うものが多かった。 よくある「助詞の連続」、「漢字の開き閉じ」、「一文の長さ」などは、ある程度の精度で検出可能ではあるが、結局執筆時に一番検出して欲しいのは「誤字脱字」だ。 文体をどんなに揃えたところで、誤字脱字があるとやはりクオリティが低く感じるし、そこさえ抑えられていれば、他のスタイル統一は訓練である程度なんとかなる。 英語のスペルチェックはかなり進んでいるが、日本語においてはそこまで革新的なものが見当たらない。あらゆるツールを試したが、結局満足のいく精度が出る誤字脱字検出は「Word の校正機能」しかなかった。 そこで筆者
技術記事を書くことは、最初はなかなかハードルの高い作業に思えます。文章を書くにはある程度の慣れが必要である考えています。 誰しも初めのうちはうまく文章を書くことができず、文章を書く訓練を重ねることで、内容を伝えやすい・理解しやすいある種の「型」を発見されているのではないかと思っています。 この記事では id:azukiazusa が普段記事を書く時に考えていることを書き下していきます。 見出しを先に書く コードは実行可能にする 文法エラーがないように 文脈依存にならないように foo や bar のような名前を使いすぎない 記事は1日寝かせる その他文法的な事項 見出しは ## から始める インラインコードブロックは装飾目的で使わない 英語と日本語の間に半角スペースを空ける おわりに 参考 見出しを先に書く 私が技術記事を書くときには最初に見出しから書き始めます。下記のような感じです。 見
発表資料作り、全体的な流れは 1 週間ぐらいかけて構想して、半日使って 15,000 字ほど書いて (コード片含む)、半日使ってスライドに起こす(結果として 6000 字ぐらい使う)、って感じですね。貯めた文字列を組み合わせている最中に構想とは別のストーリーが降ってくることも多い。— Takafumi ONAKA (@onk) July 3, 2018 このツイートの「文字を組み合わせる」のところについて、もうちょっと掘り下げてみる。*1 この記事は はてなエンジニア Advent Calendar 2022 の1月2日の記事です。昨日は id:stefafafan で 『UNIXという考え方―その設計思想と哲学』を読んだ - stefafafan の fa は3つです でした。 3 つのポイント 知っていること 7 割、聞いたことがあること 2 割、知らないこと 1 割 引用しやすいワー
howto-tech-docs.md 技術文書の書き方 このメモは、私（@ymmt2005）が長年にわたってソフトウェアプロダクト開発に関わってきて 2022年現在こうしたほうが良いと考えているベストプラクティスです。 科学的な分析等に基づくわけではない経験則であるため、今後も随時見直すことがありますし、 ここに書いてあることが常に正しいわけでもあらゆるソフトウェア開発に適するわけでもありません。 しかしながら、実務経験が豊富で、モダンな技術スタックに明るいエンジニアの経験則は一定の 役に立つのではないかと考えて記します。 技術文書とは ここでは、ソフトウェア開発で技術者が書くべき文書ということにします。 ソフトウェアエンジニアにも役割がいろいろあり、アーキテクトと independent contributor では書く文書が違うということはあるでしょうけれど、ここではごっちゃにします。
ウェブ制作や開発の仕事で文章を扱う機会は多いはず。書き手は不自然に思っていない文章でも、読み手は違和感をもっていることがあります。文章校正テクニックを覚えるだけでおかしな表現は少なくなり、読みやすい文章を書けるようになります。 本記事では、ICS MEDIAで実践している文章校正の一例を紹介します。 レベル1、基本的な校正ルールを使う いろんな場面で使える基本的な文章校正テクニックから紹介します。 テクノロジー系の名詞は正しく記載しているか テクノロジー系の名詞を間違って使うと、「本当に技術に詳しいの？」と読者からの信頼度が下がります。名詞は大文字小文字、スペース有無含めて正確に記述しましょう。 Github → GitHub（Hは大文字） Javascript → JavaScript（Sは大文字） After Effect → After Effects（複数形の「s」を忘れてはいけな
おすすめなカンファレンス用プロポーザルの書き方 こんにちは、builderscon 主宰の牧です！今回は builderscon tokyo 2017の一般セッション公募開始に合わせて、「カンファレンス用プロポーザルの書き方」について、私なりの知見を共有させていただきたいと思います。 builderscon.io 技術カンファレンスに登壇したい！そう思ってプロポーザルを応募したものの、採用されずにガッカリしてしまう… そんな経験をしたことがある技術者の方は多いと思います。 私はこれまで自身でも様々なプロポーザルを応募してきましたが、さらに審査側として膨大な数のプロポーザルの取捨選択をしてきました。カンファレンス主催者としてはなるたけ多くのおもしろいプロポーザルを採用したいと考えており、審査時には長い時間をかけ、悩みながらプロポーザルを吟味しています。 ですが、審査をしていると実はかなりの数
大学や大学院で論文の書き方を鍛え上げた人たちには遠く遠く及ばないが、僕の様なはぐれもの1でも最近は Amazon 社内で文書の質が高いと評価してもらえるまでにはなった。Software Engineer として、コードでのアウトプットはもちろん大事だけど、文書のアウトプット(およびそれによって得られた実際のアウトプット)は同じだけ重要である2。今回は自分が最近どういうところに気をつけて技術文書を書いているのか、ということについて数年後の自分が忘れてないことを確かめられる様にまとめておく。 そもそも文書とは？ 英語だと document。ここで指す(技術)文書とは、人間が読む文体で書かれた技術に関連する情報、といったものだ。具体的に言うと以下の様なものを想定している: 新しいプロジェクトの骨子を説明する資料 会議の叩き台となる 1 枚ペラ 本番環境に変更を加えるにあたっての包括的な情報や具体
当サイトが最も参考にさせて頂いている 小野田博一先生の新刊が出版されます！ 『話す・聞く・考える 「論理力の基本」トレーニングブック』 ７月３１日発売。予約受付中！ 【論理的思考力と議論】 第１章 論理的な主張の仕方 第２章 論理的な反論の仕方 第３章 詭弁！誤謬！レトリック！ 第４章 現実のパワーゲーム おまけ やる夫で学ぶ議論のしかた（AA） まとめ 毎日読む論理思考ノート 【上級者の実戦を観察する】 Twitter勢 配信サイト勢 競技ディベート勢 【心理と対話】 思考を歪める心理効果 ゴードン心理学 【その他】 管理人の議論ログ 更新履歴(Twitter) 厳選したリンクと書籍 考えを表現する能力は、 考えそのものと同じくらいに重要である。 －Ｂ.バルバ－ 第１章 論理的な主張の仕方―サブメニュー 【考えを表現する能力】 根拠のない主張が同意を得られるのは元々同じ意見の人からだけ。
思った事とか勉強したことをまとめて書き出したり表現したりする、つまりアウトプットを、なかなか書けない時とするする書ける時というのがある。その違いは何なのかとか、アウトプットがうまくいかないときに、それを妨げている心理的障害は何なのかを掘り下げていくうちに、これ自体が一つのアウトプットになった。つまり今回は成功だ。 だいたい僕はアウトラインの途中らへんまでを構成して、そしてそれを半分くらい文章として肉付けしているあたりで厭になって辞めてしまうことが多いのだった。ブログの下書きにはそういった文書が積み重なっていて圧巻だ。 なんで途中で辞めてしまうのか。それはやはり劣等感と遠くでつながっている話であるようだった。僕はまず辞めてしまうタイミングに着目して、その時どういうふうに感じているか、自分と向き合ってみた。すると、僕がアウトプットの中途で書くのをやめてしまうのは、「大したことをやっているように
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
