Technical Writer Job at Ledgent Technology, Largo, FL

ekUzS25icklNQmIxbGNaUTVObSttckgwd1E9PQ==
  • Ledgent Technology
  • Largo, FL

Job Description

We are seeking technical writer candidates to present to our client in Largo, FL, for a contract to hire role. The position will be onsite daily.

The custom software lacks comprehensive documentation, creating challenges in understanding code functionality, business rules, and database structures. To address this, we aim to hire a technical writer to document the software systematically. This documentation will include technical/white papers for designated code modules, processes, business rules, table structures, and data dictionaries.

Project Objectives

  1. Provide clear, comprehensive documentation for the custom software.
  2. Facilitate knowledge transfer and ease onboarding for new team members.
  3. Enable efficient troubleshooting and software maintenance.
  4. Standardize and centralize all documentation for future scalability.

Scope of Work

  1. Module-Level Documentation
    • Breakdown of all designated code modules.
    • Description of functionality and interdependencies.
  2. Process Documentation
    • Overview of software workflows.
    • Step-by-step explanation of key processes.
  3. Business Rules
    • Comprehensive list of business rules embedded in the code.
    • Explanation of how rules are applied and their impact on processes.
  4. Database Documentation
    • Table structures, including field definitions and data types.
    • Entity-relationship diagrams (ERDs) to illustrate relationships.
  5. Data Dictionary
    • Definitions of all database fields and their usage.
    • Index of terms and acronyms used across the software.

Approach and Methodology

  1. Preparation
    • Conduct initial meetings with IT and development teams to identify key areas requiring documentation.
    • Create an inventory of modules, processes, and database structures to be documented.
  2. Technical Writer Onboarding
    • Provide the technical writer with access to software, code repositories, and SMEs (Subject Matter Experts).
    • Share existing documentation and relevant materials.
  3. Documentation Development
    • Follow a structured process:
      1. Review code and system behavior.
      2. Interview SMEs for additional context.
      3. Draft documentation and validate accuracy with the development team.
    • Use templates for consistency across all documents.
  4. Validation and Review
    • Iterative review process involving IT leadership and SMEs.
    • Update documentation based on feedback.
  5. Finalization and Handoff
    • Compile all documents into a central repository.
    • Provide training to IT staff on accessing and maintaining documentation.

Deliverables

  1. Technical/White Papers for all designated code modules.
  2. Comprehensive process documentation.
  3. Business rules documentation.
  4. Database structure documentation, including ERDs.
  5. Data dictionary with field definitions and usage.
Desired Skills and Experience

technical writer for custom software system - ASP.Net, C#, .Met

All qualified applicants will receive consideration for employment without regard to race, color, national origin, age, ancestry, religion, sex, sexual orientation, gender identity, gender expression, marital status, disability, medical condition, genetic information, pregnancy, or military or veteran status. We consider all qualified applicants, including those with criminal histories, in a manner consistent with state and local laws, including the California Fair Chance Act, City of Los Angeles' Fair Chance Initiative for Hiring Ordinance, and Los Angeles County Fair Chance Ordinance. For unincorporated Los Angeles county , to the extent our customers require a background check for certain positions, the Company faces a significant risk to its business operations and business reputation unless a review of criminal history is conducted for those specific job positions.

Job Tags

Contract work, Local area,

Similar Jobs

Interactive Resources - iR

Senior Data Governance Analyst Job at Interactive Resources - iR

 ...Our client is seeking a motivated and detail-oriented Senior/Lead Data Governance Analyst to support the growth and execution of their enterprise data governance framework. This role will work cross-functionally with product owners, stewards, and technical teams to help... 

New York University

Clinical assistant professor internal medicine medicine Job at New York University

 ...Start with the Best People As Long Island's only academic medical center, Stony Brook Medicine is about making a real difference...  ...available 24/7 as needed so the Hospitalist is fully supported in clinical decision-making. Opportunities exist for career... 

Michaels Stores

8811- FT Framing Manager Job at Michaels Stores

Store - BALT-ANNAPOLIS, MD Lead and coach a team of framers who focus on building customer relationships while creating a framing solution for their art. Drive custom framing sales. Assist customers in creating a memorable framing solution for their art. Major Activities...

The Bunny Hive

Part-Time Teacher for Children's Classes Job at The Bunny Hive

 ...friendly, personable and professional manner Facilitate an environment for relationship building before, during and after class Assist in clean-up activities after class Requirements Warm and friendly personality with the confidence and ability to lead a... 

Ameristar Casino Resort Spa St. Charles

SECURITY OFFICER Job at Ameristar Casino Resort Spa St. Charles

 ...position Boyd Gaming Corporation to maximize value for our shareholders, our team members and our communities. Job Description Security Officers are responsible for ensuring the safety and security of guests, team members, and company assets. Duties include but not...