# DMP Planning Session Tool DMP Template Version 1.0 (October 15, 2024) A facilitation tool for running a structured data management planning meeting. A team walks through a fixed set of guided questions mapped to the eight elements of the DMP template, captures notes in real time, tags them for downstream action, and exports a structured document for the DMP author to draft the formal plan from. --- ## Files in this package | File | Description | |---|---| | `DMP_Planning_Session_Tool.html` | The tool itself. Open in any modern browser — no server or installation required. | | `README.md` | This file. | --- ## Quick start 1. Open `DMP_Planning_Session_Tool.html` in a browser (Chrome, Firefox, Edge, or Safari — any recent version). 2. No internet connection is required after the page first loads. Google Fonts and marked.js are loaded from CDN on first open; after that the tool works offline. 3. Fill in **Project Information** on the first section, then work through Elements 1–8 with your team. 4. Export notes when you're done. --- ## Navigation The tool is divided into **10 sections**, one displayed at a time. | Section | Content | |---|---| | ★ Project Information | Structured form for DMP header fields | | 01 – 08 | The eight DMP elements, each with guided discussion questions | | ◎ MD Preview | Live rendered preview of the full Markdown export | **Sidebar** — all sections are listed on the left. Click any item to jump directly to it. Each item shows a note count (or completion status) so you can see at a glance where the team has and hasn't been. **Bottom bar** — Previous / Next buttons step through sections in order. The dot strip shows position and completion state across all sections; individual dots are also clickable. --- ## Capturing notes Each question has a text input at the bottom of its block. - Type a note and press **Enter** (or click **+ Add**) to save it. - Notes appear immediately above the input in the order they were added. - To delete a note, click the **✕** button on the right edge of the note. There is no save button. All changes are written to the browser's localStorage automatically after every action. --- ## Tags After saving a note, four tag buttons appear beneath it. Tags are optional but drive the section summaries and global rollups in the export. | Tag | Meaning | |---|---| | **✓ Decision** | Something the team decided in this meeting | | **→ Action Item** | A task that must be completed before or during DMP writing | | **? Needs Follow-up** | An unresolved question that requires research or a separate conversation | | **⬡ Flag for DMP** | Content that can be pulled near-verbatim into the formal DMP document | Click a tag once to apply it; click again to clear it. Only one tag per note. A colored left border on the note card reflects the active tag. The legend at the bottom of each element section shows the color key. --- ## Marking sections complete Each section has a **Mark Complete** button in the top-right corner. This is a team signal, not a lock — notes can still be added or removed after a section is marked complete. Completed sections show a green badge in the sidebar and a filled dot in the bottom navigation strip. Overall progress (completed sections / total sections) is shown in the progress bar in the top bar. --- ## Exporting Click **📄 Export Notes** in the top bar to open the export modal. ### Markdown Report (`.md`) A structured Markdown document containing: - YAML frontmatter with project metadata - A project information table - One `##` section per DMP element, with the DMP Template guidance quoted, each question as a `###` subheading, and notes as a bullet list with inline tag labels - Per-element tagged-item summaries (Decisions, Actions, Follow-ups, Flagged for DMP) - Three global rollup tables at the end: - All action items across all elements, numbered and cross-referenced - All open questions / needs follow-up - All DMP-flagged content, grouped by element **Intended use:** Hand the `.md` file to the DMP author. The "Flagged for DMP" consolidated section is the primary drafting input — it aggregates everything the team explicitly endorsed as ready to include. Action items and follow-ups tell the author what still needs to be resolved before certain sections can be finalized. ### CSV Data (`.csv`) A flat table with one row per note and the following columns: `section_id` · `section_label` · `element_num` · `question_num` · `question_text` · `note_text` · `tag` · `timestamp` Project information fields are included as rows with `section_id = project_info`. Every question has at least one row, even if no notes were captured (empty `note_text`), so the schema is complete and filterable. **Intended use:** Quantitative analysis of coverage, tag distribution, or action item tracking in Excel or Google Sheets. Also useful for importing into a future session (see below). ### Copy / Download Both formats support **Copy to Clipboard** and **Download** directly from the export modal. The download filename includes the current date (`DMP_Session_YYYY-MM-DD.md` / `.csv`). --- ## Markdown Preview page Navigate to the **◎ MD Preview** section (last item in the sidebar, pink) to see a fully rendered version of the Markdown export — tables, headings, blockquotes, bullet lists, and tag labels all styled using the tool's design system. The preview is generated on demand. Click **↺ Refresh** after adding notes to update it. This page is read-only; all editing happens in the element sections. --- ## Importing a previous session Click **↑ Import** in the top bar. The import modal has three tabs: ### { } JSON Session Paste the contents of a `.json` file previously saved with **↓ Save**. This is a lossless full-state restore — all notes, tags, timestamps, completion status, and the last active section are preserved exactly. ### 📄 Markdown Export Upload or paste the contents of a `.md` export produced by this tool. The parser reads: - The project information table to restore header fields - Each `## Element N:` section and `### QN.` question block to rebuild notes - Inline tag labels (`**\`[✓ Decision]\`**` etc.) to restore tags - The `**Status:** ✓ Complete` line to restore completion state **Note:** Timestamps on restored notes will reflect the time of import, not the original capture time. ### 📊 CSV Export Upload or paste the contents of a `.csv` export produced by this tool. The parser reads `section_id`, `question_num`, `note_text`, and `tag` columns. `project_info` rows restore the project information form fields. Both the Markdown and CSV panels support **drag-and-drop** file upload in addition to the file chooser and paste. --- ## Saving a session Click **↓ Save** in the top bar to download the current session state as a `.json` file (`DMP_Session_YYYY-MM-DD.json`). This file captures everything: all notes, tags, timestamps, completion status, and the last active section index. Store this file as the working backup for a multi-session engagement. Import it at the start of the next session to resume exactly where you left off. > Session data is also automatically persisted to the browser's `localStorage` under the key `dmp_v2`, so closing and reopening the browser tab will restore the most recent state without needing to explicitly save. However, `localStorage` is browser- and device-specific — it will not persist across different machines, browsers, or private/incognito sessions. Use the JSON save/import workflow for anything that needs to travel. --- ## Starting a new session Click **↺ New** in the top bar. A confirmation modal will warn you that all current notes and progress will be cleared. Export or save first if you need to keep the current work. --- ## Theme Click **◗ Dark** / **☀ Light** in the top bar to toggle between the dark (default) and light variants of the Osaka Jade design system. The preference is saved to `localStorage` and persists across sessions independently of note data. --- ## Technical notes - **Single-file application.** The entire tool is contained in one `.html` file. No build step, no dependencies to install, no server. - **External resources loaded on first open:** Google Fonts (IBM Plex Sans, JetBrains Mono) and marked.js (Markdown renderer) are fetched from CDN. After the first load with an internet connection, browsers typically cache these; the tool will continue to work offline for subsequent sessions. - **Browser compatibility:** Tested in Chrome 120+, Firefox 121+, Edge 120+, Safari 17+. Requires ES2020 support. Does not support Internet Explorer. - **Data stays local.** No data is sent to any server. All session state lives in the browser's `localStorage` and in files you explicitly download. - **localStorage key:** `dmp_v2` (session data), `dmp_theme` (theme preference). Clearing browser storage will reset the tool to a blank state. - **File size:** The tool HTML file is approximately 80 KB. Exported Markdown files for a fully populated session are typically 40–50 KB. CSV exports are typically 35–45 KB. --- ## Questions the export is designed to answer The Markdown export is structured so a DMP author can work through the following without needing to re-read every note: 1. **What did the team decide?** → Decisions sections per element 2. **What do I still need before I can write this section?** → Action Items and Follow-ups per element, plus the global rollups 3. **What language can I use directly?** → "Flagged for DMP" consolidated section 4. **What's the overall state of planning?** → Per-element status lines and note counts --- *Tool design: Osaka Jade aesthetic (dark and light). Session format version: v2.*