Docfd User Guide

Back to Docfd engineering case study

Introduction

TODO: Briefly state who this guide is for and what users can accomplish with Docfd.

Start Here

• Installation
• Getting started

Using Docfd

• Searching
• Filtering and navigating results
• Scripts and repeatable workflows
• Configuration

Reference and Help

• Keyboard reference
• Troubleshooting

TODO: Add links to any additional reference pages once their scope becomes clear.

Recording TODOs

• Record a 15–25 second first-search clip: start Docfd, enter a query, navigate between results, and open one in its associated application.
• Reuse or extract the filter/undo segment from the portfolio’s “Searching Docfd with Docfd” recording.
• Record a 20–30 second history-and-script clip: perform several actions, edit their command history, apply the edit, and save the result as a script.
• Decide whether --list-scripts, --script, and --start-with-script need a short recording or only a terminal transcript.
• Decide whether search-scope narrowing needs a 15–20 second clip after the filtering documentation has been written.
• Reuse the portfolio PDF recording for PDF conversion and result opening; do not make a duplicate guide recording unless the portfolio clip is too engineering-focused.

Installation, configuration precedence, non-interactive exit statuses, supported extensions, and debug logging should normally use commands and expected output rather than recordings.