├── .gitignore ├── LICENSE.md ├── Readme.md └── vagrant ├── Vagrantfile ├── init.sh └── visualizer.jar /.gitignore: -------------------------------------------------------------------------------- 1 | vagrant/.vagrant 2 | -------------------------------------------------------------------------------- /LICENSE.md: -------------------------------------------------------------------------------- 1 | GNU LESSER GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | 9 | This version of the GNU Lesser General Public License incorporates 10 | the terms and conditions of version 3 of the GNU General Public 11 | License, supplemented by the additional permissions listed below. 12 | 13 | 0. Additional Definitions. 14 | 15 | As used herein, "this License" refers to version 3 of the GNU Lesser 16 | General Public License, and the "GNU GPL" refers to version 3 of the GNU 17 | General Public License. 18 | 19 | "The Library" refers to a covered work governed by this License, 20 | other than an Application or a Combined Work as defined below. 21 | 22 | An "Application" is any work that makes use of an interface provided 23 | by the Library, but which is not otherwise based on the Library. 24 | Defining a subclass of a class defined by the Library is deemed a mode 25 | of using an interface provided by the Library. 26 | 27 | A "Combined Work" is a work produced by combining or linking an 28 | Application with the Library. The particular version of the Library 29 | with which the Combined Work was made is also called the "Linked 30 | Version". 31 | 32 | The "Minimal Corresponding Source" for a Combined Work means the 33 | Corresponding Source for the Combined Work, excluding any source code 34 | for portions of the Combined Work that, considered in isolation, are 35 | based on the Application, and not on the Linked Version. 36 | 37 | The "Corresponding Application Code" for a Combined Work means the 38 | object code and/or source code for the Application, including any data 39 | and utility programs needed for reproducing the Combined Work from the 40 | Application, but excluding the System Libraries of the Combined Work. 41 | 42 | 1. Exception to Section 3 of the GNU GPL. 43 | 44 | You may convey a covered work under sections 3 and 4 of this License 45 | without being bound by section 3 of the GNU GPL. 46 | 47 | 2. Conveying Modified Versions. 48 | 49 | If you modify a copy of the Library, and, in your modifications, a 50 | facility refers to a function or data to be supplied by an Application 51 | that uses the facility (other than as an argument passed when the 52 | facility is invoked), then you may convey a copy of the modified 53 | version: 54 | 55 | a) under this License, provided that you make a good faith effort to 56 | ensure that, in the event an Application does not supply the 57 | function or data, the facility still operates, and performs 58 | whatever part of its purpose remains meaningful, or 59 | 60 | b) under the GNU GPL, with none of the additional permissions of 61 | this License applicable to that copy. 62 | 63 | 3. Object Code Incorporating Material from Library Header Files. 64 | 65 | The object code form of an Application may incorporate material from 66 | a header file that is part of the Library. You may convey such object 67 | code under terms of your choice, provided that, if the incorporated 68 | material is not limited to numerical parameters, data structure 69 | layouts and accessors, or small macros, inline functions and templates 70 | (ten or fewer lines in length), you do both of the following: 71 | 72 | a) Give prominent notice with each copy of the object code that the 73 | Library is used in it and that the Library and its use are 74 | covered by this License. 75 | 76 | b) Accompany the object code with a copy of the GNU GPL and this license 77 | document. 78 | 79 | 4. Combined Works. 80 | 81 | You may convey a Combined Work under terms of your choice that, 82 | taken together, effectively do not restrict modification of the 83 | portions of the Library contained in the Combined Work and reverse 84 | engineering for debugging such modifications, if you also do each of 85 | the following: 86 | 87 | a) Give prominent notice with each copy of the Combined Work that 88 | the Library is used in it and that the Library and its use are 89 | covered by this License. 90 | 91 | b) Accompany the Combined Work with a copy of the GNU GPL and this license 92 | document. 93 | 94 | c) For a Combined Work that displays copyright notices during 95 | execution, include the copyright notice for the Library among 96 | these notices, as well as a reference directing the user to the 97 | copies of the GNU GPL and this license document. 98 | 99 | d) Do one of the following: 100 | 101 | 0) Convey the Minimal Corresponding Source under the terms of this 102 | License, and the Corresponding Application Code in a form 103 | suitable for, and under terms that permit, the user to 104 | recombine or relink the Application with a modified version of 105 | the Linked Version to produce a modified Combined Work, in the 106 | manner specified by section 6 of the GNU GPL for conveying 107 | Corresponding Source. 108 | 109 | 1) Use a suitable shared library mechanism for linking with the 110 | Library. A suitable mechanism is one that (a) uses at run time 111 | a copy of the Library already present on the user's computer 112 | system, and (b) will operate properly with a modified version 113 | of the Library that is interface-compatible with the Linked 114 | Version. 115 | 116 | e) Provide Installation Information, but only if you would otherwise 117 | be required to provide such information under section 6 of the 118 | GNU GPL, and only to the extent that such information is 119 | necessary to install and execute a modified version of the 120 | Combined Work produced by recombining or relinking the 121 | Application with a modified version of the Linked Version. (If 122 | you use option 4d0, the Installation Information must accompany 123 | the Minimal Corresponding Source and Corresponding Application 124 | Code. If you use option 4d1, you must provide the Installation 125 | Information in the manner specified by section 6 of the GNU GPL 126 | for conveying Corresponding Source.) 127 | 128 | 5. Combined Libraries. 129 | 130 | You may place library facilities that are a work based on the 131 | Library side by side in a single library together with other library 132 | facilities that are not Applications and are not covered by this 133 | License, and convey such a combined library under terms of your 134 | choice, if you do both of the following: 135 | 136 | a) Accompany the combined library with a copy of the same work based 137 | on the Library, uncombined with any other library facilities, 138 | conveyed under the terms of this License. 139 | 140 | b) Give prominent notice with the combined library that part of it 141 | is a work based on the Library, and explaining where to find the 142 | accompanying uncombined form of the same work. 143 | 144 | 6. Revised Versions of the GNU Lesser General Public License. 145 | 146 | The Free Software Foundation may publish revised and/or new versions 147 | of the GNU Lesser General Public License from time to time. Such new 148 | versions will be similar in spirit to the present version, but may 149 | differ in detail to address new problems or concerns. 150 | 151 | Each version is given a distinguishing version number. If the 152 | Library as you received it specifies that a certain numbered version 153 | of the GNU Lesser General Public License "or any later version" 154 | applies to it, you have the option of following the terms and 155 | conditions either of that published version or of any later version 156 | published by the Free Software Foundation. If the Library as you 157 | received it does not specify a version number of the GNU Lesser 158 | General Public License, you may choose any version of the GNU Lesser 159 | General Public License ever published by the Free Software Foundation. 160 | 161 | If the Library as you received it specifies that a proxy can decide 162 | whether future versions of the GNU Lesser General Public License shall 163 | apply, that proxy's public statement of acceptance of any version is 164 | permanent authorization for you to choose that version for the 165 | Library. 166 | -------------------------------------------------------------------------------- /Readme.md: -------------------------------------------------------------------------------- 1 | # Idea Flow Mapping Tools 2 | 3 | This is the original version of the Idea Flow Mapping software. We're currently rewriting the tools to work as a thin client that works with a REST service, so the data collection is easy to port to a variety of editors. Check out openmastery.org for details about the learning community we're building around Idea Flow. ETA for the new version should be done around August/Sept 2016 to support Intellij, Eclipse, MS Visual Studio, and a mobile app. 4 | 5 | For the time being, we've got an Intellij plugin, which is what all the original data collection described in the book, [Idea Flow](http://leanpub.com/ideaflow), used. It works. It's a bit clunky. We collaborated as a team by checking all of our Idea Flow Maps into Git. 6 | 7 | This version has two parts: 8 | 9 | * The IFM Intellij Plugin 10 | * The IFM Visualizer (vagrant) 11 | 12 | ## The Intellij Plugin 13 | 14 | You can install the plugin by adding "http://openmastery.org/tools/updatePlugins.xml" as a [custom plugin repository](https://www.jetbrains.com/idea/help/custom-plugin-repositories-dialog.html) and then installing "ideaflow-plugin". 15 | 16 | The Idea Flow Mapping buttons show up on the main tool bar, so if you have your main bar hidden, you'll have to make the bar visible to see the buttons. 17 | 18 | To start recording an Idea Flow Map, right click on any directory and select: New > IFM File. The editor activity will automatically start streaming to your IFM file. In general, keep one IFM per task/story. 19 | 20 | ### IFM Buttons 21 | 22 | **Pause** - Temporarily pauses the flow of editor activity to the IFM file. If you are working on something that you don't want recorded, for example, it can be handy to pause so you don't clutter up your data. 23 | 24 | **Active Task (dropdown)** - You can have multiple Idea Flow Maps open at the same time and switch between active tasks. Switching the active task will cause editor activity to stream to the different files. From the task drop down menu, you can also open the active task in the visualizer or remove it from the working set (your active task list). 25 | 26 | **Event Note (paper)** - Creates a note (shown as a line) on the IFM with some context information about what's going on. Use notes at the beginning of subtasks or major shifts in the work, so the IFM tells a clear story about the structure of the developer's task. 27 | 28 | **Conflict (red bulb)** - Toggle conflict on to start the conflict, toggle off to end the conflict. A conflict starts at the beginning of an unexpected observation. After writing a bit of code then executing it to see if it works, if the code doesn't work as expected, start the conflict and type your observation question at the prompt, i.e. "Why is this code throwing a NPE?" Ending the conflict will prompt for a resolution. 29 | 30 | **Learning (blue bulb)** - Toggle learning on to start the learning band, toggle off to end the learning band. When you start learning, you'll be prompted for the question your trying to answer. Try to translate the *focus* of your learning into a concise question. End the learning band once you have an answer to your question. In general, record learning bands at the start of a task and the start of a subtask. 31 | 32 | **Rework (yellow bulb)** - Toggle rework on to start the rework band, toggle off to end the rework band. When you start rework, you'll be prompted about what you're reworking. Any code changes that are non-functional in nature (refactoring), repair or redesign when there is nothing broken (repairing tests) -- consider rework. 33 | 34 | Start with tracking conflicts and events only, then *after* you get used to tracking conflicts, incorporate the other types. 35 | 36 | ### Nested and Linked Bands 37 | 38 | Conflicts can be nested inside learning and rework bands as nested conflicts by depressing the conflict button after the learning or rework button is already depressed. 39 | 40 | Bands can also be linked together by "flipping" to a rework band when a conflict or learning band is already depressed. Semantically, linked bands are represented as a linked list, which causes the visualization tools to collapse and treat these bands as a group. 41 | 42 | #### Use cases for Nesting and Linking 43 | 44 | * **Detailed Troubleshooting Model** - The developer is in troubleshooting a behavior, has a hypothesis for what is wrong, and it will take a substantial amount of rework before the hypothesis can be validated, in the mean time more conflicts can happen along the way. Start the initial conflict. When the hypothesis is discovered, "flip" to rework. If new conflicts are discovered along the way, create nested conflicts inside the rework. When the original hypothesis is validated, end the rework. 45 | 46 | * **Trial and Error** - The developer is struggling to figure out an acceptable design strategy. The first conflict is a "strategy conflict", i.e. the strategy isn't going to work. Then the developer has to figure out a plan B (learning), "flip" to blue. Once the developer has a plan B, they have to rework the code, "flip" to yellow. Create a linked triplet for each trial and error. 47 | 48 | * **Unexpected Dependencies** - The developer is figuring out a strategy and runs into an unexpected dependencies that messes up their plans before they even start writing code. Figure out the strategy (learning), then when the unexpected dependency is discovered, start a nested strategy conflict. After chasing down the dependency and resolving the concern, end the nested conflict and resume learning. 49 | 50 | ## IFM Visualizer 51 | 52 | To open Idea Flow Maps in the visualizer (again, prototype version), you'll need to install the VirtualBox VM, which is super easy with vagrant. The VM Webserver runs on port 8989 in an attempt to not clash with other ports you might be using for your application. Once the server is running, you can open Idea Flow Maps from within the plugin, by choosing "Open in Visualizer" by right clicking the IFM file, or selecting the option in the active task drop down menu. 53 | 54 | Install [VirtualBox](https://www.virtualbox.org/wiki/Downloads) 55 | 56 | Install [Vagrant](https://docs.vagrantup.com/v2/installation/index.html) 57 | 58 | Clone this repository 59 | 60 | git clone git@github.com:openmastery/tools.git 61 | 62 | Start up the visualizer 63 | 64 | cd tools/vagrant 65 | vagrant up 66 | 67 | Install a new version of the visualizer 68 | 69 | vagrant reload --provision 70 | 71 | At the moment, the visualizer is passed a complete file path from the plugin. This means that the path to your .ifm files on the host machine must be accessible via the same path on the VM. If you're a mac user and your .ifm files are somewhere under your user home, this should just work. If not, you'll need to update the config.vm.synced_folder setting in vagrant/Vagrantfile to be some ancestor of the directory or directories containing your .ifm files. 72 | -------------------------------------------------------------------------------- /vagrant/Vagrantfile: -------------------------------------------------------------------------------- 1 | # -*- mode: ruby -*- 2 | # vi: set ft=ruby : 3 | 4 | # Vagrantfile API/syntax version. Don't touch unless you know what you're doing! 5 | VAGRANTFILE_API_VERSION = "2" 6 | 7 | Vagrant.configure(VAGRANTFILE_API_VERSION) do |config| 8 | # All Vagrant configuration is done here. The most common configuration 9 | # options are documented and commented below. For a complete reference, 10 | # please see the online documentation at vagrantup.com. 11 | 12 | # Every Vagrant virtual environment requires a box to build off of. 13 | config.vm.box = "trusty-amd64" 14 | 15 | config.vm.box_url = "https://cloud-images.ubuntu.com/vagrant/trusty/current/trusty-server-cloudimg-amd64-vagrant-disk1.box" 16 | 17 | config.vm.provision :shell, :path => "init.sh" 18 | 19 | config.vm.network "forwarded_port", guest: 8080, host: 8989 20 | 21 | config.vm.synced_folder ENV['HOME'], ENV['HOME'] 22 | 23 | end 24 | -------------------------------------------------------------------------------- /vagrant/init.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | if [[ ! `dpkg-query -W -f='${Status}' openjdk-7-jre-headless | grep "install ok"` ]]; then 4 | echo "Installing JRE" 5 | sudo apt-get -y update 6 | sudo apt-get -y install openjdk-7-jre-headless 7 | else 8 | echo "JRE already installed, skipping" 9 | fi 10 | 11 | echo "Downloading visualizer.jar" 12 | #rm -f visualizer.jar 13 | #wget --tries=10 --append-output=wget.out -O visualizer.jar http://ideaflow.org/visualizer-latest.jar 14 | 15 | echo "vagrant?" 16 | ls /vagrant 17 | 18 | echo "Stating visualizer..." 19 | java -jar /vagrant/visualizer.jar context=visualizer & 20 | 21 | echo "Waiting for visualizer to start..." 22 | sleep 20 23 | -------------------------------------------------------------------------------- /vagrant/visualizer.jar: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/openmastery/tools/5bfb331b12055e8baee8fd1c8d357b8df7925785/vagrant/visualizer.jar --------------------------------------------------------------------------------