- Draft only, descriptors not part of page content
- Include/link relevant troubleshooting for each article at bottom
- Instructional articles provide templates and guides to use specified feature
- Instructional articles link to corresponding knowledge base article for complete explanation of relevant DWT component/feature
- Documentation pre-amble
- Introduce product, features, use cases, platform support, etc.
- Lightly touch on other introductory sections
- Link to three most common use cases as prepared by marketing team
- Could just merge into Introduction
- Link to DWT code gallery
- Link to finished samples from other guides
- State implemented features
- Link to corresponding basic usage guides for explanation - initialization, acquiring images, etc.
- Include quick installation
- Use existing finished Hello World (end result includes scanning, uploading, and editing images - visually impactful features)
- Consider moving installation and initialization to Hello World instead of within Hello World Scanning Pages
- Originally called Fundamental Features, implies this is prerequisite knowledge that requires more understanding of the product, renamed basic "Basic" to imply this is easy and sufficient to use on its own
- Lay out article dependencies - first article is necessary for all others, but no need for strict reading order past first article
- Alternatively: Basic Usage Guide
- Replaces "Initiate DWT Object"
- Alternative titles: DWT Initialization, SDK Initialization, Initializing the SDK
- KB DWT Initialization and maybe DWT Resource Files
- Introduce getting images from scanners and from files into DWT
- Link to webcam add-on
- Toggling basic UI options
- Possibly just one section if editing article is a stub
- Currently only mentions simple geometric transformations, may seek to include others. Otherwise this may be a stub article
- Article is dependent on viewer article (recommend as prerequisite)
- KB Image Manipulation
- Manipulating and processing received image data
- Include link to barcode reader add-on
- Rotation, crop, maybe link to blank page detection
- KB Image Manipulation
- Reordering, tagging images, removing blank pages, etc.
- KB Data Handling
- Link to
FileUploaderfor advanced use cases
- Originally "Advanced Features"
- Reframed to prioritize application over theory
- Quick intro to web frameworks and their benefits
- Mention installation and license key
- In each framework page, link to finished project on github
- KB DWT Initialization, DWT Resource Files
- Note special use case of customizing messages with translated messages for language localization purposes
- KB DWT Resource Files
- Unclear about purpose/inclusion in previous draft
- KB Imaging Devices
- End user installation, port configuration, origin access control, etc.
- KB The Dynamsoft Service
- Unclear about contents, currently only one API has references to segmented upload
- KB Networking Features
- High performance mode for many users, within Citrix remote desktop
- Use descriptive name instead of Enhanced Mode
- KB Enhanced Mode
- KB Remote Scan
- Using the
FileUploaderfor large upload from the background service - KB The
FileUploader
- ConvertToBlob and ConvertToBase64
- Previous deleted topic: Get Image Data
- KB Data Handling
- Creating a document with image selection, getting image id from selected document
- KB Image Manipulation
- Local encrypted image storage/caching
- KB Data Handling
- Unfamiliar with content
- Introduce each add-on
- Installation and setup
- Possibly move to subsection of Knowledge Base, and then leave corresponding user guides?
- May incentivize purchase, but may leave customers frustrated if they don't expect that it's an add-on
- Title could indicate required add-on, i.e. Scanning From Camera (Webcam Add-on)
- KB Licensing
- Not finalized title
- Additional instructional section that includes:
- License key management
- Version upgrades
- SDK installation
- Deployment/production-related tasks
- Some of these instructions are out of place when placed with guides on SDK features
- Windows, Linux, MacOS
- Using the installer vs. npm
- Using license keys
- KB DWT Resource Files
- Standard, npm, and yarn installation
- Cover license key instructions as well
- KB Licensing
- Knowledge base articles that are not guides
- Supplementary information for guides
- Alternatively: Reference Guide, References
- Supported operating systems, web frameworks, environments, drivers, etc.
- Use content from resource file FAQ
- Details about runtime behavior
- Rename, too similar to name of guide
- May need to talk about the whole data flow behind DWT here
- Link to TWAIN specification for further reading
- High performance file uploading through the Dynamsoft Service
- Should mention/contrast against Service mode (typical behavior)
- Describe its relationship with the Dynamsoft Service
- General UI behavior, could be put under
WebTwain
- General UI behavior, could be put under
- Describe device acquisition, connection to the Dynamsoft Service, device driver, device interface, etc.
- Includes image editing, markup, colors, compression, etc.
- Alternative: The Image Buffer
- Probably unnecessary because very little content not covered by guides and API reference
- Current content of "File Types" in introduction
- May be split into inbound data, outbound data, buffered data, and cached data
- Connection between server and web app, web app and dynamsoft service, dynamsoft service and data sources, dynamsoft service and server
- In-depth explanation of license types and behaviors
- May need to slightly tweak sub-heading organization
- Considering moving under Knowledge Base
- Not sure if sub-headings should be pre-expanded, may be too crowded
- Have a drop down menu with all the subsections visible first heading to the FAQ page
- Certain FAQ articles contain novel info, and are used frequently enough that they should be their own guides outright, so they will be moved in to basic or advanced guides
- Basic Usage and Advanced Usage could be put under a common "User Guide" section, but this may be too much nesting
- Not sure where to put add-on guides - integrated with usage sections or in their own section? May need a knowledge base article dedicated to add-ons
- Group some advanced usage guides together? Particularly FileUploader, Enhanced Mode, Remote Scan, Segmented Upload