summaryrefslogtreecommitdiff
path: root/doc/documentation/VISION.md
diff options
context:
space:
mode:
authorLiz Abinante <eabinante@gmail.com>2017-01-22 14:39:51 -0800
committerLiz Abinante <eabinante@gmail.com>2017-01-22 21:03:49 -0800
commit381912e494bb912d9953af5f3cff5ad4f248cc51 (patch)
tree67664599a3f6d1f827851f1d0ebde54512219afc /doc/documentation/VISION.md
parent915806bb762a7f1ebf0d55caa2d7833c940608c5 (diff)
downloadbundler-381912e494bb912d9953af5f3cff5ad4f248cc51.tar.gz
first pass :dash: at breaking up documentation into good chunks
Diffstat (limited to 'doc/documentation/VISION.md')
-rw-r--r--doc/documentation/VISION.md26
1 files changed, 26 insertions, 0 deletions
diff --git a/doc/documentation/VISION.md b/doc/documentation/VISION.md
new file mode 100644
index 0000000000..3d660ee36d
--- /dev/null
+++ b/doc/documentation/VISION.md
@@ -0,0 +1,26 @@
+# Documentation vision
+
+Currently, documentation for using Bundler is spread across two places:
+
+1. built-in `help` (including usage information and man pages)
+2. [Bundler documentation site](http://bundler.io)
+
+Additional documentation about using Bundler to publish gems can also be found on the [RubyGems guides](http://guides.rubygems.org/).
+
+## Goals
+
+Bundler documentation should provide users with assistance:
+
+1. Installing Bundler
+2. Using Bundler to manage an application's dependencies
+3. Using Bundler to create, package, and publish gems
+
+Our goal is to provide three types of documentation:
+
+* High level overviews that provide topical guidance
+* Step-by-step tutorials
+* Command-specific reference material for the CLI
+
+Additionally, this documentation should be readily available in a logical place and easy to follow.
+
+Someday, we'd like to create deep-dive reference material about the inner workings of Bundler. However, while this is part of our overall vision for Bundler documentation, it is not the focus of our current work.