チケットの書き方（情報共有のための文書の書き方）
Qiitaに一度書いた内容ですがアカウント削除とともに消えた内容です。 Redmine絡みのイベントで書いた記事だったはず。 手元のメモから出てきたのでこちらに記載。 背景 メンバーの一部がスムーズに情報共有できるチケットが書けず苦戦しており、 相談を受けた時に色々言った内容を書き起こしたもの。 チケットというより、情報共有のための文章の書き方が正しいかも。 前提 業務ツールとしてチャット、Redmine、Wikiを使用していた。 チーム内の連絡や相談はチャットがメイン。 チャットで会話して相談・整理・調整する。 タスク、課題はチケット化して管理。 ナレッジはWikiに書いて共有。 業務内容はシステム開発と運用保守でソフトウェア開発ではない。 Redmineをタスク・課題管理に使用している環境で 以下のような考えを元に各ツールを使用し業務を行っていた。 ・チャットは流れる情報（フロー情報）
Build optimized websites quickly, focus on your content | Docusaurus
Build optimized websites quickly, focus on your content Powered by MDXSave time and focus on text documents. Simply write docs and blog posts with MDX, and Docusaurus builds them into static HTML files ready to be served. You can even embed React components in your Markdown thanks to MDX. Built Using ReactExtend and customize your project's layout by writing React components. Leverage the pluggabl
さらばGoogleDocs、ドキュメントをWebマニュアルに移行したおはなし(ShanonAdventCalendar2017・3日目)
Docker gitbook kzhirata さらばGoogleDocs、ドキュメントをWebマニュアルに移行したおはなし(ShanonAdventCalendar2017・3日目) こちらの記事から2年半。今年は、仕事でdockerばかり使ってました。 docker使うと、デプロイ方法の細かいところをインフラ担当者と話す手間がなくなるからお互い嬉しいですね。 今回は、なるべく手をかけずにWEBのマニュアル smpdoc.shanon.co.jp を構築した話を書きます。 今までは、google docsに書いたマニュアルをPDF化してサポート担当者に連絡してサポートサイトに公開していました。この作業が非生産的で改善したいけど、社内でプロジェクト化するには、優先順位の低い課題でした。 いかに手をかけずにWEB化するか。出来る限りOSSを使って維持管理を楽にするというポリシーで設計しました
Building unified documentation for the web
$200K 1 10th birthday 4 abusive ads 1 abusive notifications 2 accessibility 3 ad blockers 1 ad blocking 2 advanced capabilities 1 android 2 anti abuse 1 anti-deception 1 background periodic sync 1 badging 1 benchmarks 1 beta 83 better ads standards 1 billing 1 birthday 4 blink 2 browser 2 browser interoperability 1 bundles 1 capabilities 6 capable web 1 cds 1 cds18 2 cds2018 1 chrome 35 chrome 81
About this guide | Google developer documentation style guide | Google for Developers
Send feedback About this guide Stay organized with collections Save and categorize content based on your preferences. This style guide provides editorial guidelines for writing clear and consistent Google-related developer documentation. If you're new to the guide and looking for introductory topics about our style, then start with Highlights, Voice and tone, and Text-formatting summary. Otherwise
技術ドキュメンテーションのためのreStructuredTextとMarkdownを比較する | POSTD
Markdown と reStructuredText はどちらもマークアップ言語で、どのテキストエディタを使っても簡単に入力できるように設計されたプレーンテキスト形式構文です。どちらにもマークアップされたテキストをHTMLやPDFなどの出版形式に変換できるツールが多数あります。 これらのマークアップ言語は多くのドキュメンテーションシステムの基礎となるため、昨今のソフトウェア開発者はマークアップ言語をよく知っておく必要があります。この記事ではプログラマ視点でMarkdownとreStructuredTextのトレードオフを分析します。 Markdownが輝きを放つ場所 テキスト入力による豊富な書式設定で複雑なドキュメント構造を記述することができるマークアップ言語は長く輝かしい歴史を持っており、その歴史は少なくとも1970年代初めの troff とTeXまで遡ることができます。 これらの形式
超高速な開発ができるわけ | Yakst
あるひとりの人がシステムを作ったが故にそのシステムに精通している場合に、最も生産的な開発が行われる。しかしこれは、ひとりの人がシステムの面倒を見ることを超えてシステムが成長する時には矛盾してしまう。 ある状況下において、特定の開発者たちが他の人の10倍生産性が高くなることがあるのはなぜかについて議論してみましょう。 ヒント : 開発者の話ではなく、状況が大きなカギ。 生産性が非常に高いことにウキウキした気分になるのはいつでしょうか。新しい機能が指先からあふれ出てくる時？それは、私たちが関わるツールのことを知り尽くしている時、あるいはもっと決定的に言うと、自分がシステムを変更しつつある時に起こるのです。自分のバックパック、それも自分で詰め込み、そしてひとつひとつの小袋の中まで何年にもわたる旅行を経て調整してきたバックパックの中身を知っているように、システムを知ることです。それぞれのモジュール
CloudFlare's JSON-powered Documentation Generator
CloudFlare's JSON-powered Documentation Generator Loading... Everything that it's possible to do in the CloudFlare Dashboard is also possible through our RESTful API. We use the same API to power the dashboard itself. In order to keep track of all our endpoints, we use a rich notation called JSON Hyper-Schema. These schemas are used to generate the complete HTML documentation that you can see at h
Documentation
Collectives™ on Stack Overflow Find centralized, trusted content and collaborate around the technologies you use most. Learn more about Collectives Teams Q&A for work Connect and share knowledge within a single location that is structured and easy to search. Learn more about Teams We have shut down Stack Overflow Documentation. Documentation was our attempt at improving existing reference material
読みやすいREADMEを書く | Yakst
いくつかのオープンソースプロジェクトを公開している筆者からの、読みやすくユーザーにやさしいREADMEを書くためのアドバイス。 この記事は、Rowan Manning氏による「Writing a Friendly README」(2016/3/14)を翻訳したものです。 あなたのプロジェクトのREADMEは、かなり重要です。そこはプロジェクトに初めて来た人が大抵最初に見るであろう場所であり、唯一のドキュメントであることもよくあります。あなたのオープンソースプロジェクトにとってのREADMEは、企業にとってのウェブサイトのようなものです。ウェブサイトはユーザーエクスペリエンスの注目を集めるところですが、READMEがユーザー観点で考えられることはほとんどありません。 この記事では、分かりやすいREADMEを書くために役立ち、開発者(ユーザー)の要求に見合い、開発者がプロジェクトを初めて見たの
textlintで日本語の文章をチェックする
textlintはMarkdownなどテキスト向けのLintツールで、テキスト版ESLintみたいな感じのツールです。 JavaScriptでルールを書けるテキスト/Markdownの校正ツール textlint を作った | Web Scratch 最近azu/JavaScript-Plugin-Architectureという小さな書籍を書いていて、色々簡単に使えるような仕組みを追加しています。 この記事では簡単なtextlintの導入方法について紹介します。 公式サイトには一部ルールを含むオンラインデモが公開されています。 textlint · The pluggable linting tool for text and markdown ドットインストールにてNode.jsのインストール、textlintの利用方法、エディタとの連携などのチュートリアルが公開されています。Node.
tldr pages
Simplified and community-driven man pages The tldr pages are a community effort to simplify the beloved man pages with practical examples. Try the live demo below, have a look at the PDF version, or follow the installation instructions. § Installation As of now, our most mature client is the Node.js one, which you can easily install from npm: npm install -g tldr There are many more clients that ha
The APIs.json Discovery Format: Potential Engine in the API Economy
The InfoQ Trends Reports 2023 eMag The InfoQ trends reports provide a snapshot of emerging software technology and ideas. We create the reports and accompanying graphs to aid software engineers and architects in evaluating what trends may help them design and build better software. Our editorial teams also use them to help focus our content on innovator and early adopter trends.
The Power of RAML
The InfoQ Trends Reports 2023 eMag The InfoQ trends reports provide a snapshot of emerging software technology and ideas. We create the reports and accompanying graphs to aid software engineers and architects in evaluating what trends may help them design and build better software. Our editorial teams also use them to help focus our content on innovator and early adopter trends.
Lean Documentation
The InfoQ Trends Reports 2023 eMag The InfoQ trends reports provide a snapshot of emerging software technology and ideas. We create the reports and accompanying graphs to aid software engineers and architects in evaluating what trends may help them design and build better software. Our editorial teams also use them to help focus our content on innovator and early adopter trends.
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
The State of API Languages
論文等、書き物を他人に見せる前のチェックリスト – 上田ブログ
Founder of API Blueprint Discusses Progress
Big Improvements In Ebook Creation
documentation - Best way to document a packet protocol - Stack Overflow