Alfrescoのインストール作業をコマンド単位で丁寧に記載しますDeleted articles cannot be recovered. Draft of this article would be also deleted. Are you sure you want to delete this article?
documentationjs + add-text-to-markdownでREADME.mdのAPIリファレンスを自動更新
documentationjs + add-text-to-markdownでREADME.mdのAPIリファレンスを自動更新 documentationjsはJSDocからドキュメントを生成できるツールで、ES2015以降のコードにも対応しています。 (TypeScriptは対応してないようです) 以前はMarkdownへの出力が難しかったのですが、いつのまにかdocumentation build -f mdでMarkdownでのAPIドキュメントが生成できるようになっていました。 これを使うことで、ライブラリを書いてそのJSDocからドキュメントを生成して、READMEのUsageセキュクションを自動的に更新できるようになっています。 以前もできたのですが、かなりトリッキーなテーマを書いたりしないといけませんでした。(後stdoutへの出力がなかった気がします) –theme for
API 設計ガイド | Cloud API Design Guide | Google Cloud
変更履歴 はじめに これは、ネットワーク API の一般的な設計ガイドです。2014 年以来 Google 内部で使用され、Cloud API やその他の Google API を設計するときに Google が従うガイドです。この設計ガイドは、外部のデベロッパーへの情報提供と、互いの連携作業の効率化のためにここで共有されています。 Cloud Endpoints のデベロッパーには、このガイドは、gRPC API を設計するときに特に役立つことがあり、そのような場合にはこれらの設計原則を使用することを強くおすすめします。ただし、このガイドの使用は必須ではありません。Cloud Endpoints と gRPC はガイドに従わなくても使用できます。 このガイドは、gRPC API を中心に、REST API と RPC API の両方に適用されます。gRPC API では、プロトコル バッ
オンラインドキュメントへCI/CDを適用している話
SkyWayとWebRTC開発者コミュニティ4年間の軌跡とCMC_Meetupで学んだこと、実践したこと
大自然言語時代のための、文章要約 - Qiita
Deleted articles cannot be recovered. Draft of this article would be also deleted. Are you sure you want to delete this article? さまざまなニュースアプリ、ブログ、SNSと近年テキストの情報はますます増えています。日々たくさんの情報が配信されるため、Twitterやまとめサイトを見ていたら数時間たっていた・・・なんてこともよくあると思います。世はまさに大自然言語時代。 *from [THE HISTORICAL GROWTH OF DATA: WHY WE NEED A FASTER TRANSFER SOLUTION FOR LARGE DATA SETS](https://www.signiant.com/articles/file-transfer/the-
Google開発者向け文書スタイルガイドの要点 : IT翻訳者Blog
Googleが開発者向け文書で使っていた英語スタイルガイドが社外に公開された（Googleブログ）。 URLはこちら： Google Developer Documentation Style Guide https://developers.google.com/style/ MicrosoftやIBMは自社の英語スタイルガイドを書籍（リンク：MS／IBM）として販売するしているし、Appleは公開（リンク）している。Googleもマテリアル・デザインの一部としてスタイルを公開してはいる（リンク）が、分量が少ないため、他社と比べるとどうしても見劣りした。 そのため、「開発者向け文書」を対象としてはいるものの、ある程度の規模のスタイルガイドが公開されたのは意義深い。 そこで今回は、同スタイルガイドの要点（highlight）のみについて読んでみたい。 Highlights https://
Microsoft Corporation
This browser is no longer supported. Upgrade to Microsoft Edge to take advantage of the latest features, security updates, and technical support. Microsoft Learn. Spark possibility. Build skills that open doors. See all you can do with documentation, hands-on training, and certifications to help you get the most from Microsoft products. Learn by doing Gain the skills you can apply to everyday situ
prh - コマンドラインで文章を校正
MOONGIFTはオープンソース・ソフトウェアを紹介するブログです。2021年07月16日で更新停止しました 文章を書くというのは難しいものです。文字数もそうですが、分かりやすい文章を書くには漢字の使い方にも気をつける必要があります。あまり多用すると文章が固くなりますし、使わなすぎると幼稚に見えます。 今回紹介するオープンソース・ソフトウェアはprh、そんな文章の構成を行ってくれるソフトウェアです。 prhの使い方 prhはコマンドで実行します。replaceオプションを付ければ元の文章が書き換わりますが、それが嫌な場合は標準出力された文章を別に保存すればOKです。 $ prh path_to_document.md > ~/Downloads/result.md prhはルールファイルがあり、それを使うことで良い感じに校正してくれます。ルールファイルを差し替えれば別な校正に使うこともでき
『TagDox』とは？文章解析、自動タグ付けAIでドキュメント管理を自動化！？ | Ledge.ai
サインインした状態で「いいね」を押すと、マイページの 「いいね履歴」に一覧として保存されていくので、 再度読みたくなった時や、あとでじっくり読みたいときに便利です。
こんなに使える！今どきのAPIドキュメンテーションツール
This document summarizes a microservices meetup hosted by @mosa_siru. Key points include: 1. @mosa_siru is an engineer at DeNA and CTO of Gunosy. 2. The meetup covered Gunosy's architecture with over 45 GitHub repositories, 30 stacks, 10 Go APIs, and 10 Python batch processes using AWS services like Kinesis, Lambda, SQS and API Gateway. 3. Challenges discussed were managing 30 microservices, ensur
Microsoft Corporation
Microsoft Learn. Spark possibility. Build skills that open doors. See all you can do with documentation, hands-on training, and certifications to help you get the most from Microsoft products. Learn by doing Gain the skills you can apply to everyday situations through hands-on training personalized to your needs, at your own pace or with our global network of learning partners. Take training Find
ドキュメント作成時のあるあるアンチパターン20 - Qiita
業務でドキュメントを作成するケースは多々ある 例：仕様書・設計書・提案書・メール・障害票．．． ここでは各ドキュメント共通してありがちなアンチパターンをまとめてみました。 1. 表記がバイト表示・マイクロ秒表示 プログラムが出した数値をありのままに表示するパターン ファイルサイズが100MB, 1GBあろうと、バイト表示にする 桁数が多い数値に、桁区切り（,）を入れない 時間を何でもマイクロ秒・ミリ秒にする（1/100万秒までの精度が必要？体感で分かる？） 桁数が多い＝精度が高い＝良い文書、ではなく、見る人が必要とする精度に切り上げることが重要（売上で１円単位まで出すことが無いのと同様） 悪い例 No ファイル名 ファイルサイズ(byte) 処理時間(秒)
わかりやすいドキュメントを書くには 〜 全体像を把握できることが重要 - Qiita
Deleted articles cannot be recovered. Draft of this article would be also deleted. Are you sure you want to delete this article? はじめに エンジニアなら誰でもたくさんのドキュメントを読むことになります。 その中にはわかりにくいドキュメントも少なからずあると思います。 自分はわかりにくいドキュメントは「全体像が掴みにくい」ことが多いと感じています。 そこで、ここではわかりやすいドキュメントを書くための方法を「全体像を把握できるようにする」という視点でまとめてみました。 また、最後に具体例としてQiita APIドキュメントでわかりにくい点の指摘と改善をしてみました。 ここで扱うドキュメントの種類 ここでは仕様書やリファレンスマニュアルといった類のドキュメントを想定
Docpress - 読みやすい開発者向けドキュメントを生成
開発者向けのドキュメントシステムなんて何でも良いと思っていないでしょうか。開発者はオンラインドキュメントをよく読み、Googleで検索し、そこにあるコードをコピーして実行します。そのため、半端なドキュメントでは彼らの信頼を失ってしまうでしょう。 そこで使ってみたいのがDocpressです。Markdownベースのドキュメント生成システムです。 Docpressの使い方 デモです。左側に目次、右側にコンテンツが表示されます。 ページの下に次のページへのリンクが表示されます。 メニューは隠せます。 Docpressは文字が大きめ、デザインもすっきりしたドキュメントを生成します。使い方としても docpress s でプレビューができるなど、とても簡単に使い始められます。 Docpressはnode/JavaScript製のオープンソース・ソフトウェア（MIT License）です。 docpr
JSON Schema から API 仕様と Go コードを自動で生成する – BOT エントリーの裏側 Part.1
Eureka EngineeringLearn about Eureka’s engineering efforts, product developments and more.
【社内資料公開】運用手順書を作る時のポイントについて書いてみた | DevelopersIO
はじめに こんにちは植木和樹＠上越妙高オフィスです。本日は私がここ10年くらい意識している運用手順書を書くときのポイントについてまとめてみました。 対象読者 開発・構築したシステムを別の人に引き継ぐ予定のある人 他の人が作ったシステムを引き継ぐ担当の人 半年後の自分でも分かる手順書の書き方に困っている人 （この記事を読むのにかかる時間の目安：5分） 1. ドキュメントの冒頭に書くこと まず個々の詳細手順の前に、ドキュメント自体について記載してもらいたいことです。 1.1. ドキュメントに書かれていることを3行で書く ドキュメントの最初には、このドキュメントに何が書かれているのかを100文字くらいで書いておくと良いでしょう。 システムが増えれば増えるほど手順書も増えていくものです。見つけたドキュメントに自分の期待するものが書かれているのか、冒頭数行でわかるようになっているとうれしいです。 1
ドキュメントの継続的な開発方法 | IIJ Engineers Blog
私はソフトウェア開発を主体とするエンジニアで、 クラウドサービスの開発・運用 分散処理技術の検証とサービス利用の検討 社内の開発支援環境の開発・運用 などの業務に従事していますが、今回の記事は業務とは直接的な関係は無く、私が会社で勝手自発的に行っている取り組みについて書きたいと思います。 昨今、インターネットは生活に深く浸透し、クラウドサービスを利用することで安く簡単にWebサービスを開発、公開できるようになりました。Web技術の進化や流行の移り変りも非常に激しく、既存サービスの機能追加や新規サービスの開発は頻繁に行われています。それは弊社も例外ではありません。 このような開発の現場では、リーンソフトウェア開発への取り組みなど開発手法の最適化が積極的に行われ、様々なベストプラクティスが生みだされています。それらのベストプラクティスには、 継続的インテグレーション や 継続的デプロイメント
BookStack - 企業/組織で使えるWebベースのドキュメンテーションシステム MOONGIFT
ドキュメントを書く機会は誰にでもあるものです。開発プロジェクトがあればAPIドキュメントや仕様書、ヘルプファイルなどが必要になります。他にも数多くの場面があるでしょう。 そんな時に使ってみたいのがBookStackです。Web上で作成、編集もこなせるドキュメント管理システムです。 BookStackの使い方 トップページです。カテゴリ分けされています。 ドキュメントのアウトラインです。 実際の文章です。右側に目次が出ています。 画像やコードの埋め込みなどにも対応しています。 編集画面です。WYSIWYGエディタを使っておこないます。 BookStackはドキュメント管理であり、ドキュメント BookStack ssddanbrown/BookStack: A platform to create documentation/wiki content.
ドキュメント作業で楽をしたい - NaCl Blog
プログラマがあまりやりたがらない作業のひとつとしてドキュメント作成がよく挙げられるかと思います。 〇〇仕様書とか〇〇設計書とか〇〇手順書などの作成作業ですね。 特に成果物がdocxやxlsxのようなプレーンテキストでない場合、次のような理由で気が滅入る方も多いのではないでしょうか。 手慣れた道具(エディタ)を使うことができない 専用のソフトでよくわからない機能が裏で勝手に動いたりしてて気持ち悪い 変更履歴をトラッキングしづらい、差分をマージしづらい Markdownでさくっと書いてそれっぽいものができれば、GitHubのWikiなどにぼちぼち書き溜めておいて最後にコンパイルするみたいなやり方ができるなぁとか、そうすればわざわざドキュメント専用リポジトリを作ったりする必要もないなぁとかモヤモヤしながらいろいろ調査・検討したので以下の4構成でまとめたいと思います。 Pandocについて Pan
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
GitHub - Alfresco/alfresco-content-app: Alfresco Content Application