#documentation

[ follow ]
#collaboration
Treehouse Blog
13 hours ago
JavaScript

How to Write Good Comments in Code to Enhance Collaboration

Effective code comments enhance understanding and collaboration among developers, making code maintenance and modification easier. [ more ]
Medium
1 week ago
UX design

Design system dilemmas: similar looks, different functions

Effective component usage requires collaboration and clear documentation between designers and engineers to maintain a functional design system. [ more ]
ClickUp
1 month ago
Agile

Project Documentation: With Examples & Free Templates

High-quality project documentation is essential for project success and future reference. [ more ]
Treehouse Blog
13 hours ago
JavaScript

How to Write Good Comments in Code to Enhance Collaboration

Effective code comments enhance understanding and collaboration among developers, making code maintenance and modification easier. [ more ]
Medium
1 week ago
UX design

Design system dilemmas: similar looks, different functions

Effective component usage requires collaboration and clear documentation between designers and engineers to maintain a functional design system. [ more ]
ClickUp
1 month ago
Agile

Project Documentation: With Examples & Free Templates

High-quality project documentation is essential for project success and future reference. [ more ]
morecollaboration
time.com
2 days ago
Miscellaneous

A Palestinian Photographer Reflects on One Year of Life and Death in Gaza

Saher Alghorra's photography highlights the human impact of the ongoing conflict in Gaza, emphasizing both destruction and resilience amid humanitarian crises. [ more ]
Trakkjs
2 days ago
JavaScript

Trakk.js

Trakk.js enhances onboarding for new developers by providing real-time insights into application behavior and code execution. [ more ]
#user-experience
Nedbatchelder
1 week ago
Python

Changelog philosophy

Effort must be put into crafting changelogs and release notes to effectively communicate changes to users. [ more ]
ZDNET
3 weeks ago
JavaScript

Linux and open-source documentation is a mess: Here's the solution

Linux documentation is often outdated, poorly written, or nonexistent, which hampers user experience and support.
Lack of funding and sponsorship contributes to the burnout of documentation maintainers.
Despite many developers working hard on documentation, none are officially employed to focus on this essential task. [ more ]
Medium
1 month ago
UX design

Zero documentation: your users deserve better than a manual

Focus on creating a user-friendly product experience rather than relying heavily on extensive documentation. [ more ]
Nedbatchelder
1 week ago
Python

Changelog philosophy

Effort must be put into crafting changelogs and release notes to effectively communicate changes to users. [ more ]
ZDNET
3 weeks ago
JavaScript

Linux and open-source documentation is a mess: Here's the solution

Linux documentation is often outdated, poorly written, or nonexistent, which hampers user experience and support.
Lack of funding and sponsorship contributes to the burnout of documentation maintainers.
Despite many developers working hard on documentation, none are officially employed to focus on this essential task. [ more ]
Medium
1 month ago
UX design

Zero documentation: your users deserve better than a manual

Focus on creating a user-friendly product experience rather than relying heavily on extensive documentation. [ more ]
moreuser-experience
#productivity
ClickUp
2 weeks ago
Business intelligence

Free Report Templates for Microsoft Word | ClickUp

Utilizing report templates can significantly save time and improve the quality of reports. [ more ]
ClickUp
2 months ago
DevOps

Free Software Release Notes Templates & Examples

Software release notes serve as crucial documentation to inform users of changes, bug fixes, and improvements in a new or updated product. [ more ]
Addy
8 months ago
Web development

Developer Experience Book

Streamline core workflows for maximum velocity
Design self-explanatory APIs and create useful documentation [ more ]
Addy
8 months ago
Web development

Developer Experience Book

Streamline core workflows for maximum velocity
Design self-explanatory APIs and create useful documentation [ more ]
Addy
8 months ago
Web development

Developer Experience Book

Streamline core workflows for maximum velocity
Design self-explanatory APIs and create useful documentation [ more ]
ClickUp
2 weeks ago
Business intelligence

Free Report Templates for Microsoft Word | ClickUp

Utilizing report templates can significantly save time and improve the quality of reports. [ more ]
ClickUp
2 months ago
DevOps

Free Software Release Notes Templates & Examples

Software release notes serve as crucial documentation to inform users of changes, bug fixes, and improvements in a new or updated product. [ more ]
Addy
8 months ago
Web development

Developer Experience Book

Streamline core workflows for maximum velocity
Design self-explanatory APIs and create useful documentation [ more ]
Addy
8 months ago
Web development

Developer Experience Book

Streamline core workflows for maximum velocity
Design self-explanatory APIs and create useful documentation [ more ]
Addy
8 months ago
Web development

Developer Experience Book

Streamline core workflows for maximum velocity
Design self-explanatory APIs and create useful documentation [ more ]
moreproductivity
#markdown
CodeProject
3 weeks ago
JavaScript

6 free Markdown (.md) WYSIWYG desktop Editors - Part1

As a .NET/C# programmer, I aim to improve my Markdown skills for efficient GitHub documentation. [ more ]
Hackernoon
2 months ago
Graphic design

The Dead Simple Markdown Guide to Images | HackerNoon

Use Markdown syntax to easily add images and links in your documents. [ more ]
CodeProject
3 weeks ago
JavaScript

6 free Markdown (.md) WYSIWYG desktop Editors - Part1

As a .NET/C# programmer, I aim to improve my Markdown skills for efficient GitHub documentation. [ more ]
Hackernoon
2 months ago
Graphic design

The Dead Simple Markdown Guide to Images | HackerNoon

Use Markdown syntax to easily add images and links in your documents. [ more ]
moremarkdown
#python
Pythoninsider
1 month ago
Python

Python Insider: Python 3.13.0RC2, 3.12.6, 3.11.10, 3.10.15, 3.9.20, and 3.8.20 are now available!

Python 3.13.0RC2 is ready for testing, with a final release planned for October 1st.
Maintain third-party project compatibility and avoid using the RC in production environments. [ more ]
Matt Layman
1 month ago
JavaScript

Layman's Guide to Python Built-in Functions Matt Layman

The Python documentation is challenging for beginners, necessitating simplified explanations for better comprehension. [ more ]
Pythonmorsels
5 months ago
Python

Multiline comments in Python

One way to comment out a block of code in Python is by wrapping it in triple quotes, even though it's not a documented feature. [ more ]
Pythoninsider
1 month ago
Python

Python Insider: Python 3.13.0RC2, 3.12.6, 3.11.10, 3.10.15, 3.9.20, and 3.8.20 are now available!

Python 3.13.0RC2 is ready for testing, with a final release planned for October 1st.
Maintain third-party project compatibility and avoid using the RC in production environments. [ more ]
Matt Layman
1 month ago
JavaScript

Layman's Guide to Python Built-in Functions Matt Layman

The Python documentation is challenging for beginners, necessitating simplified explanations for better comprehension. [ more ]
Pythonmorsels
5 months ago
Python

Multiline comments in Python

One way to comment out a block of code in Python is by wrapping it in triple quotes, even though it's not a documented feature. [ more ]
morepython
Raymondcamden
1 month ago
JavaScript

Links For You (8/31/2024)

Enjoy a relaxing three-day weekend while anticipating a busy September.
The value of inclusive documentation across multiple operating systems is emphasized. [ more ]
LogRocket Blog
1 month ago
JavaScript

Advanced monorepo management with Turborepo 2.0 - LogRocket Blog

Turborepo 2.0 introduces a new terminal UI and Watch Mode, enhancing developer productivity in monorepo projects. [ more ]
#art
designboom | architecture & design magazine
1 month ago
Design

alberto frigo encodes his life as iron pixels with cubic sculpture in the little dolomites

CUBO is a monumental sculpture that embodies 20 years of Alberto Frigo's personal experiences through innovative documentation. [ more ]
Medium
7 months ago
UX design

Threads' downfall, HTML to Figma, Customer Experience 3.0, effective communication

User onboarding with less friction leads to higher conversions, but it can come with a cost.
The UX Collective focuses on elevating unheard design voices and promoting critical thinking in design. [ more ]
designboom | architecture & design magazine
1 month ago
Design

alberto frigo encodes his life as iron pixels with cubic sculpture in the little dolomites

CUBO is a monumental sculpture that embodies 20 years of Alberto Frigo's personal experiences through innovative documentation. [ more ]
Medium
7 months ago
UX design

Threads' downfall, HTML to Figma, Customer Experience 3.0, effective communication

User onboarding with less friction leads to higher conversions, but it can come with a cost.
The UX Collective focuses on elevating unheard design voices and promoting critical thinking in design. [ more ]
moreart
ClickUp
1 month ago
Graphic design

Free Employee Verification Letter Templates | ClickUp

Employment verification letters are critical in supporting employees' life events and navigating their journeys with the company. [ more ]
#developer-efficiency
Amazon Web Services
2 months ago
JavaScript

Code Clarity: Enhancing Code Understanding and Efficiency with Amazon Q Developer | Amazon Web Services

Developers spend significant time maintaining and refactoring codebases to overcome challenges like lack of documentation and unfamiliar programming languages.
Organizations can enhance developer efficiency by empowering them with tools like Amazon Q Developer for code understanding and explanation. [ more ]
DevOps.com
6 months ago
DevOps

Smoothing API Onboarding With Simulation and Documentation - DevOps.com

Investment in the API economy is increasing with over 200 million APIs available.
Challenges in API onboarding include poor documentation and inconsistently available sandboxes, impacting developer efficiency. [ more ]
Amazon Web Services
2 months ago
JavaScript

Code Clarity: Enhancing Code Understanding and Efficiency with Amazon Q Developer | Amazon Web Services

Developers spend significant time maintaining and refactoring codebases to overcome challenges like lack of documentation and unfamiliar programming languages.
Organizations can enhance developer efficiency by empowering them with tools like Amazon Q Developer for code understanding and explanation. [ more ]
DevOps.com
6 months ago
DevOps

Smoothing API Onboarding With Simulation and Documentation - DevOps.com

Investment in the API economy is increasing with over 200 million APIs available.
Challenges in API onboarding include poor documentation and inconsistently available sandboxes, impacting developer efficiency. [ more ]
moredeveloper-efficiency
Hackernoon
2 years ago
JavaScript

Code Smell 262 - Not Replaced Constants | HackerNoon

Ignoring constant replacement leads to severe security risks. [ more ]
Medium
2 months ago
JavaScript

Next.js Monorepos with Bit

Create and manage Bit workspace for NextJS and React component development. [ more ]
Pythoninsider
2 months ago
Python

Python Insider: Python 3.13.0 release candidate 1 released

Prepare third-party Python projects for 3.13 compatibility by publishing wheels on PyPI before final release. [ more ]
TechRepublic
2 months ago
Business

How to Open a Business Bank Account in 2024

Opening a business bank account helps with finance organization and professional appearance. [ more ]
#product-management
LogRocket Blog
2 months ago
Agile

Leader Spotlight: Transitioning teams to an agile mindset, with Clark Woolstenhulme - LogRocket Blog

Introducing agile workflows in traditional waterfall companies can be driven by the need to modernize and deliver high-quality code on time. [ more ]
Medium
9 months ago
UX design

The Ideal Tool for Product Requirements

AI can improve product documentation by generating accurate documents and automating certain tasks.
Product managers often struggle with non-standardized and siloed product information. [ more ]
LogRocket Blog
2 months ago
Agile

Leader Spotlight: Transitioning teams to an agile mindset, with Clark Woolstenhulme - LogRocket Blog

Introducing agile workflows in traditional waterfall companies can be driven by the need to modernize and deliver high-quality code on time. [ more ]
Medium
9 months ago
UX design

The Ideal Tool for Product Requirements

AI can improve product documentation by generating accurate documents and automating certain tasks.
Product managers often struggle with non-standardized and siloed product information. [ more ]
moreproduct-management
Theregister
4 months ago
Web design

Google's technical info about search ranking leaks online

The leaked Google documents describe an old version of Google's Content Warehouse API, offering insights into Google Search's inner workings. [ more ]
Alvinalexander
5 months ago
JavaScript

How to format source code blocks in Scaladoc comments

To embed Scala source code examples in Scaladoc comments, use {{{ and }}} characters, enabling proper code block formatting. [ more ]
DevOps.com
5 months ago
DevOps

Postman Makes AI Tool for API Management Platform Available - DevOps.com

Postman introduced Postbot AI tool for automatic API tests and documentation, aiming to enhance API quality and developer collaboration. [ more ]
#django
Greenash
5 months ago
JavaScript

On FastAPI

FastAPI succeeds by building on Django and Flask strengths while feeling modern and opinionated. [ more ]
Paolo Melchiorre
8 months ago
Python

Paolo Melchiorre - My Django roadmap ideas

New DSF board member Thibaud Colas has proposed a Django roadmap workshop.
The proposed ideas for improving Django include organizing active developer sprints, simplifying the English used in the documentation, and adding a quick start section. [ more ]
Greenash
5 months ago
JavaScript

On FastAPI

FastAPI succeeds by building on Django and Flask strengths while feeling modern and opinionated. [ more ]
Paolo Melchiorre
8 months ago
Python

Paolo Melchiorre - My Django roadmap ideas

New DSF board member Thibaud Colas has proposed a Django roadmap workshop.
The proposed ideas for improving Django include organizing active developer sprints, simplifying the English used in the documentation, and adding a quick start section. [ more ]
moredjango
Spreaker
5 months ago
Angular

Mastering Open Source Contributions with Santosh Yadav - AiA 411 - Adventures in Angular

Commitment to long-term open-source contributions is key to success in the Angular ecosystem and understanding its commit structure is crucial. [ more ]
Cogito, Ergo Sumana
5 months ago
UX design

Model UX Research & Design Docs for Command-Line Open Source

Open source projects can benefit from user experience research to improve user needs. Valuable insights can be gained from pip's documentation. [ more ]
Medium
6 months ago
Angular

OpenSource to InnerSource: Why Enterprises are Adopting this Strategy

Component-based software is easier to read, understand, and maintain.
Reusing components from other teams in an InnerSource ecosystem can enhance flexibility and efficiency. [ more ]
designboom | architecture & design magazine
6 months ago
Design

(this is) air book explores ecological and civic notions behind nic brunsdon's NGV installation

Exploration of architecture, ecology, and societal dynamics in Nic Brunsdon's Air Architecture Commission
Documentation of urgent ecological, civic, and political questions through (This is) Air installation [ more ]
LogRocket Blog
6 months ago
UX design

Understanding BPMN diagrams for process management - LogRocket Blog

Start with a BPMN diagram when developing workflows to have a clear understanding without confusion from piles of documentation.
BPMN diagrams standardize the process, making it easier to communicate and adapt within a product team. [ more ]
GitHub
7 months ago
Angular

GitHub - angular/angular: Deliver web apps with confidence

Angular is a development platform for building web applications using TypeScript/JavaScript.
Angular documentation encourages contributions with clear setup instructions and guidelines. [ more ]
#best-practices
MarTech
7 months ago
Marketing tech

5 simple ways to improve customer experience | MarTech

Understanding customers' key goals leads to a seamless experience.
Documentation of interactions is crucial for customer satisfaction. [ more ]
Medium
9 months ago
Angular

Different Code Documenting Strategies

Documentation is essential for guiding future maintainers and aligning team members to a shared understanding of the codebase.
Good documentation is comprehensive, reliable, and provides clear, up-to-date, and accessible instructions. [ more ]
MarTech
7 months ago
Marketing tech

5 simple ways to improve customer experience | MarTech

Understanding customers' key goals leads to a seamless experience.
Documentation of interactions is crucial for customer satisfaction. [ more ]
Medium
9 months ago
Angular

Different Code Documenting Strategies

Documentation is essential for guiding future maintainers and aligning team members to a shared understanding of the codebase.
Good documentation is comprehensive, reliable, and provides clear, up-to-date, and accessible instructions. [ more ]
morebest-practices
Medium
7 months ago
UX design

My Design System Journey: Building The Plane While Flying

Defining a style guide is crucial as the first step in building a design system.
Pattern libraries ensure usability-tested UI elements ready for implementation in the design system. [ more ]
LogRocket Blog
7 months ago
UX design

Critical UX artifacts for ongoing documentation (+template) - LogRocket Blog

Creating and maintaining ongoing UX documentation is important for maintaining alignment and avoiding wasted efforts.
Key UX artifacts for documentation include user personas, empathy maps, value proposition canvas, user journey maps, and interview snapshots. [ more ]
New York Post
8 months ago
New York City

New Yorkers in key City Council districts back Adams in veto fight over cop-stops bill, fear it will slow NYPD response times

Many New Yorkers are concerned that increased documentation for police interactions could slow down NYPD response times.
Residents believe that officers should be able to focus on fighting crime rather than paperwork. [ more ]
Addy
8 months ago
UX design

Developer Experience Book

Streamline core workflows for maximum velocity
Design self-explanatory APIs and create useful documentation [ more ]
Addy
8 months ago
Web design

Developer Experience Book

Streamline core workflows for maximum velocity
Design self-explanatory APIs and create useful documentation [ more ]
Medium
8 months ago
Scala

Two Lines of Code Eluded me for Several Months

Coding experience does not always translate to easily solving complex bugs.
Lack of documentation and community support can make bug-solving challenging. [ more ]
WSJ
9 months ago
Education

WSJ News Exclusive | Congress Gives Harvard Two Weeks to Produce Documents for Antisemitism Investigation

The House committee has requested documentation from Harvard University regarding anti-Jewish activity.
The documentation includes internal emails, proof of disciplinary actions against harassment, and information on foreign donations. [ more ]
www.theguardian.com
9 months ago
London

British Museum told to keep better records after theft of 1,500 items

The British Museum must keep a comprehensive register of all items in its collections after the theft of up to 1,500 objects over recent years.
The museum is already taking steps to address the issue, including identifying unregistered or inadequately registered objects and completing documentation and digitization of the entire collection within five years. [ more ]
Rubyflow
10 months ago
Ruby on Rails

How to add a man page to your Ruby project

Learn how to create a man page for a Ruby CLI command.
Enhance the user-friendliness of a Ruby CLI by adding a man page. [ more ]
Pycoders
10 months ago
Python

PyCoder's Weekly | Issue #603

SciPy successfully transitioned to Meson for the Python 3.12 release.
A detailed article provides an unbiased evaluation of environment and packaging tools in Python.
ChatGPT can be used to quickly document Python code and projects. [ more ]
Smashing Magazine
10 months ago
UX design

Designing Web Design Documentation - Smashing Magazine

Good documentation in web design and development is interactive and constantly evolving.
Documentation is more than just a guide - it is a statement of principles and best practices.
Digital design documentation should be both beautiful and useful - a guide and manifesto all at once. [ more ]
Smashing Magazine
10 months ago
UX design

Designing Web Design Documentation - Smashing Magazine

Good documentation in web design and development is interactive and constantly evolving.
Documentation is more than just a guide - it is a statement of principles and best practices.
Digital design documentation should be both beautiful and useful - a guide and manifesto all at once. [ more ]
Smashing Magazine
10 months ago
UX design

Designing Web Design Documentation - Smashing Magazine

Good documentation in web design and development is interactive and constantly evolving.
Documentation is more than just a guide - it is a statement of principles and best practices.
Digital design documentation should be both beautiful and useful - a guide and manifesto all at once. [ more ]
#design studio
Medium
10 months ago
Graphic design

Lessons I learned from Starting a Design Studio

Define tools and ways of working early on.
Centralize documentation and resources.
Admin tasks can be overwhelming, use tools to streamline processes.
Remember that the design project is ultimately the client's vision, not your own. [ more ]
Medium
10 months ago
Graphic design

Lessons I learned from Starting a Design Studio

Define tools and ways of working early on.
Centralize documentation and resources.
Admin tasks can be overwhelming, use tools to streamline processes.
Remember that the design project is ultimately the client's vision, not your own. [ more ]
Medium
10 months ago
Graphic design

Lessons I learned from Starting a Design Studio

Define tools and ways of working early on.
Centralize documentation and resources.
Admin tasks can be overwhelming, use tools to streamline processes.
Remember that the design project is ultimately the client's vision, not your own. [ more ]
Medium
10 months ago
Graphic design

Lessons I learned from Starting a Design Studio

Define tools and ways of working early on.
Centralize documentation and resources.
Admin tasks can be overwhelming, use tools to streamline processes.
Remember that the design project is ultimately the client's vision, not your own. [ more ]
moredesign studio
[ Load more ]