InfoQ ホームページ ドキュメンテーション に関するすべてのコンテンツ
-
JetBrains、IntelliJベースのライティングツールWriterSideを発表
JetBrainsは、WriterSideにより開発者とライターが、書き込み、テスト、ビルドのワークフローを使用して技術文書を作成できることを目指している。この新しいツールはIntelliJ-platform IDEsをベースにしており、ここ数年JetBrains製品のほとんどのドキュメント作成に使用されている。
-
AWSがGitHubで公開している公式ドキュメントを廃止
今後数日(原文投稿は2023-06-03)で、AWSは現在GitHubで公開されているAWSドキュメントの廃止を行う。プロジェクトの結果を検討し、内部ドキュメントを手作業で同期するオーバーヘッドを考慮した結果、公開リポジトリのほとんどを廃止を決定した。
-
より良いユーザーエクスペリエンスを構築するためのドキュメンテーションにおける言葉の重要性
製品やドキュメントに使用する言葉は、人を不愉快にさせたり、人を傷つけたりすることがある。正確で、複雑なメタファーに依存せず、否定的な意味合いを持たずにメッセージを伝える言葉を、私たちは選ぶことができる
-
-
Yari、新しいMDN Webドキュメントプラットフォーム
MozillaのWebドキュメント用多言語リソースであるMozilla Developer Network (MDN) は、最近、MDN Web Docsの新しいプラットフォームであるYariを立ち上げた。Yariは、MDNの開発、保守、および寄稿の負担を軽減する。MDNコンテンツはGitHubに保存され、プルリクエストを介して提供できるようになった。
-
新しいMDJSマークアップ言語によりJavaScriptをMarkdownに追加してインタラクティブなドキュメント作成が可能に
Open Web Components（@OpenWc）の創設者であるThomas Allmer氏はMDJSをリリースした。MDJSは、Markdownの一種であり、開発者が自身のMarkdownドキュメントに実行可能なJavaScriptコードを含めることができる。MDJSは、通常のMarkdownコンテンツとして解釈することも、Webコンポーネントを含むインタラクティブなドキュメントを生成するために徐々に拡張することもできる。
-
Try .NETによるインタラクティブな.NETドキュメントの作成
Microsoftは先頃、.NET Core用の対話型ドキュメントジェネレータであるTry .NETをオープンソース化した。さまざまなプログラミング言語用の同種ツール(Jupyterなど)と同じように、説明テキストと実行可能なライブコードの両方を含んだドキュメントを生成する。
-
AmazonがTextractの一般供与を発表、ECM市場へ参入
I先日のプレスリリースで、Amazonは、テキストおよび構造化文書データからコンテンツを抽出する、フルマネージドなマシンラーニングサービスであるAmazon Textractの一般供与を開始すると発表した。Amazon Textractを使用することにより、ドキュメントワークフローの自動化、ダウンストリームアプリケーションで使用する重要な情報のインデックス化およびカタログ化が実現する。
-
エンタープライズコンテンツ管理にインテリジェンスを提供するために、GoogleはDocument Understanding AIをリリース
最近のGoogle Cloud Next Conferenceで、GoogleはDocument Understanding AIと呼ばれる新しいベータ版の機械学習サービスを発表した。このサービスはエンタープライズコンテンツ管理（ECM）の業務をターゲットにしており、人工知能（AI）と機械学習（ML）を使用して、顧客が非構造化コンテンツからキーバリューペアを編成、分類、抽出できるようにしている。
-
Googleがオープンソースドキュメンテーションを改善する”Season of Docs”プログラムをローンチ
Google が Season of Docs をローンチした。オープンソースプロジェクト向けのドキュメンテーション改善を狙ったプログラムである。オープンソースコントリビュータとテクニカルライターでメンタリングの関係を築き、様々なオープンソーステクノロジーに向け、より優れた、より包括的なドキュメント作成を助ける。
-
TSDoc - TypeScriptソースコードのドキュメント化フォーマット
TSDocは、TypeScriptソースコードを文書化するための新たなフォーマットの提案である。既存のTypeScript APIドキュメントパーザはJSDocに基づく構文を受け入れるが、JSDocの拡張部分に関しては実装間で一貫性がなかった。
-
Microsoft、Google、MozillaがWebドキュメントで提携へ
ブラウザの主要３ベンダが共同で、それぞれのWeb APIリファレンスドキュメントをMozillaのMDNに統一するとともに、今後の取り組みを支援するアドバイザリグループを立ち上げると発表した。このグループではMDNを、Webプラットフォームドキュメントおよびリファレンスのための唯一の正式資料(single point of truth)として運用を開始する。
-
ブログがアジャイルチームに力を与える
チームの思考と意思決定を各自の受信箱からブログにすることで誰でもアクセスできるようになり、将来見つけられやすくになり、全員が参照できる。ドキュメントを書くよりブログを書いて知識を移行し、コードに文脈を与えるプロジェクトの歴史を文書化することができる。
-
Webドキュメント改善のためMozillaがMDNを一新する
MozillaはMDN一新計画を発表した。MDNはMDN Web Docsのままではあるが、製品ドキュメントとは分けられる。開発者の間では、MDNは高品質のドキュメントで人気のある場所の1つとして知られている。Mozillaは"MDNがWebのドキュメントでもっともよい唯一のリソース"となることを望んでいる。
-
GitHubによるオープンソースに関する調査結果
GitHubがオープンソースプロジェクトに関する調査を実施し、その分析結果を発表した。GitHubは、開発者がオープンソースとどうかかわっているか、ドキュメントの役割は何か、そして、プロジェクトでみられるネガティブなやりとりのレベルと影響について関心がある。