New Feature Documentation

Problem: Introducing a new feature that is similar to an existing feature but with a unique set of parameters and behaviors.

Solution: A clean overview of the feature that immediately addresses the most pressing user’s questions. Then a deep-dive into the related settings and behaviors.

https://library.tradingtechnologies.com/user-setup/ocp-tt-self-match-prevention-by-id.html

Premium Feature Documentation

Problem: Explanation of a high-end, add-on set of features that are positioned for more demanding users.

Solution: Created a one-stop shop with a robust introduction to the feature and detailed ‘Prerequisites’ section to show how to implement this premium feature.

https://library.tradingtechnologies.com/trade/ttpo-premium-order-types-overview.html

Procedural Documentation

Problem: Showing a multiple-step process with custom parameters for each exchange.

Solution: Added a step-by-step procedure with explanations for each unique set of parameters.

https://library.tradingtechnologies.com/user-setup/ac-managing-counterparties.html

Getting Started Video

Problem: Frequent calls to support for new users just getting up and running with the .NET API.

Solution: An easy-to-follow video guide focused on showing each step in the setup process.

https://library.tradingtechnologies.com/tt-net-sdk/articles/gs-getting-started.html

Migration Documentation

Problem: Aid users to navigate the large number of changes required for the next version of the REST API.

Solution: I created an easy to scan and color-coded migration document that concisely reflected the severity and impact of each change. This allows users to access the impact and prioritize each change.

https://library.tradingtechnologies.com/tt-rest/v2/gs-migrate.html

Cross-Platform API Documentation

Problem: API users having a difficult time mapping API fields to trader’s GUI items and exchange-required FIX tags.

Solution: Added a mapping table with annotated screenshot to remove any confusion between the backend code and front end GUI items.

https://library.tradingtechnologies.com/tt-net-sdk/articles/as-tt-retry.html

Platform-wide Documentation

Problem: When developing a new SaaS, we needed a more scalable and easily deployable way to deliver documentation for the entire trading platform.

Solution: Leveraged docs-as-code methodology to deliver a new and custom documentation library. Created new Git-based documentation workflows and automated publishing for quicker documentation updates.

https://library.tradingtechnologies.com/tthelp.html

Automated Release Notes

Problem: Product managers needed a way to draft release notes within the internal bug-tracking system and display on the external user-facing website.

Solution: Updated and implemented a Python script to query JIRA for all relevant release note content then assemble into the external website.

https://library.tradingtechnologies.com/release_notes/

Documentation from Schemas

Problem: Users need to quickly identify their latest FIX schema based on environment, type, and version. Due to frequent updates, we needed a way to automatically display all available permutations.

Solution: Developed an automated build process using Python to parse each separate FIX schema and accurately display the correct identifying values.

https://library.tradingtechnologies.com/tt-fix/general/System_Overview.html#fix-schemas