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

LiveWell Group

Director of Finance And Administration Job at LiveWell Group

 ...advisors, and financial institutions. Facilitate the seamless flow of information for tax filings, annual audits, and the maintenance of credit facilities or project-based financing. Payroll and Compensation Administration: Manage the comprehensive payroll function,... 

Shop Extraordinary

Videographer and Editor (Social Media) Job at Shop Extraordinary

About The Company The visionaries and operators behind Manhattan Vintage and Artists & Fleas are bringing together a love of home, design, and vintage with the launch of Material Matters, a new brand and showcase dedicated to treasure hunting for your home. Our inaugural...

Grace Life Church of the Nazarene

Children's Pastor / Children's Ministry Director Job at Grace Life Church of the Nazarene

 ...Position Summary: The Childrens Pastor or Childrens Ministry Director leads a vibrant and engaging ministry for children from birth through 6th grade. This role partners with families to nurture lifelong faith in Jesus Christ through age-appropriate teaching, relational... 

Siemens Healthineers

Material Handling Forklift Operator - 1st Shift Job at Siemens Healthineers

 ...schedule (Goods Receipt / Warehouse / Transport / Dispatch). 1st Shift Hours : 5:00am 1:30pm, Monday Friday. As a Material Handling Forklift Operator 1st Shift at our Plainfield, Indiana, Distribution Center, you will be responsible for: Use of powered... 

Insight Global

Inventory Specialist Job at Insight Global

 ...Job Title: Inventory Specialist / On-Site Representative Location: Gulfport, MS Start Date: Late January Duration: 2-3 Month Contract Pay Rate: $23/hr -$25/hr About the Role Were looking for a team member to support operations and help provide Inventory...